Skip to main content
PUT
/
api
/
partner
/
v2
/
webhook-settings
cURL
curl --request PUT \
  --url https://staging-api.capa.fi/api/partner/v2/webhook-settings \
  --header 'Content-Type: application/json' \
  --header 'partner-api-key: <partner-api-key>' \
  --data '
{
  "url": "https://some-webhook-endpoint.url"
}
'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.capa.fi/llms.txt

Use this file to discover all available pages before exploring further.

Updates the webhook URL where your partner account receives event notifications. To disable webhook delivery, send null as the url value.
For details on webhook payloads and HMAC validation, see the Webhooks Guide.

​
Use Cases

  • Set a webhook URL: Start receiving notifications for transaction status changes and KYC events.
  • Update the URL: Point notifications to a new server after a migration.
  • Disable webhooks: Send url: null to stop receiving notifications.

​
Error Codes

​
Common Errors

HTTP StatusCodeMessage
401UNAUTHORIZED”API Key is missing”
401UNAUTHORIZED”Invalid API Key format”
401UNAUTHORIZED”Invalid API Key”
403INVALID_PARTNER_FLOW”The partner has an invalid flow.”

​
Endpoint-Specific Errors

HTTP StatusCodeMessage
400INVALID_USER_INPUT_ERROR”Invalid User Input”

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Body

application/json
​
url
string | null
required

the url where the webhook notifications will be sent to. To reset the value null can be sent in the body.

Example:

"https://some-webhook-endpoint.url"

Response

200 - application/json

Allows an affiliated partner to update the settings for receiving webhook notifications.

​
success
boolean
Example:

true

​
data
object