POST
/
register
/
webhooks
Register a webhook endpoint
curl --request POST \
  --url https://thirdparty-sandbox.staging.qonto.co/register/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Qonto-Partner-Id: <api-key>' \
  --header 'X-Qonto-Staging-Token: <api-key>' \
  --data '{
  "callback_url": "https://example.com/myCallbackUrl",
  "enabled": true,
  "secret": "1qA+9OSwfnm0NuhF+b8CJA=="
}'
{
  "id": "37824615-afec-4340-b700-0981b5f0c319",
  "created_at": "2021-08-17T12:31:32.689Z",
  "updated_at": "2021-08-17T12:31:32.689Z",
  "callback_url": "https://example.com/myCallbackUrl",
  "enabled": true,
  "secret": "1qA+9OSwfnm0NuhF+b8CJA=="
}

Authorizations

​
Authorization
string
header
required

Bearer authorization header: Bearer <token>. To get your <token>, please sign up to the Developer Portal.

​
Qonto-Partner-Id
string
header
required

API Key authorization header: Qonto-Partner-Id: <partner_id>. To get your <partner_id> please, sign up to the Developer Portal.

​
X-Qonto-Staging-Token
string
header
required

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Body

application/json
​
callback_url
string
required

Your webhook endpoint

Example:

"https://example.com/myCallbackUrl"

​
enabled
boolean
default:true
required

Whether the webhook should be used or not

Example:

true

​
secret
string
required

Secret used for applying HMAC-SHA256 to the webhook event payload

Example:

"1qA+9OSwfnm0NuhF+b8CJA=="

Response

Returns the webhook endpoint registered.

​
callback_url
string
required

Your webhook endpoint

Example:

"https://example.com/myCallbackUrl"

​
enabled
boolean
default:true
required

Whether the webhook should be used or not

Example:

true

​
secret
string
required

Secret used for applying HMAC-SHA256 to the webhook event payload

Example:

"1qA+9OSwfnm0NuhF+b8CJA=="

​
id
string<uuid>
Example:

"37824615-afec-4340-b700-0981b5f0c319"

​
created_at
string<date-time>
Example:

"2021-08-17T12:31:32.689Z"

​
updated_at
string<date-time>
Example:

"2021-08-17T12:31:32.689Z"