⚠️
This endpoint requires authentication using a valid partner-api-key.
Field | Type | Required | Description |
|---|
url | string | ✅ | The URL where webhook notifications will be sent. To disable webhook delivery, send null. |
curl --request PUT \
--url https://staging-api.capa.fi/api/partner/v2/webhook-settings \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'partner-api-key: API-KEY' \
--data '
{
"url": "https://some-webhook-endpoint.url"
}
'
| Field | Type | Description |
|---|
id | string | The entity ID. Example: 12a121ad-cbea-4ec4-9e0a-5c861e528bba |
partnerId | string | ID of the partner that owns the settings. Example: 12a121ad-cbea-4ec4-9e0a-5c861e528bba |
url | string | The webhook URL. Example: https://some-webhook-endpoint.url |
createdAt | string | Timestamp of when the settings were created. Example: 2024-04-05 13:45:27.063 |
updatedAt | string | Timestamp of the last update. Example: 2024-04-05 13:45:27.063 |
{
"success": true,
"data": {
"id": "12a121ad-cbea-4ec4-9e0a-5c861e528bba",
"partnerId": "12a121ad-cbea-4ec4-9e0a-5c861e528bba",
"url": "https://some-webhook-endpoint.url",
"createdAt": "2024-04-05 13:45:27.063",
"updatedAt": "2024-04-05 13:45:27.063"
}
}
- Set a Webhook URL: Partners who want to start receiving webhook notifications can use this endpoint to register their desired URL.
- Update the Webhook URL: If the webhook destination changes (e.g., server migration), partners can update the URL by sending a new value.
