Skip to main content
POST
Register a webhook endpoint

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.

Headers

X-Qonto-Staging-Token
string

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>
read-only
Example:

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

created_at
string<date-time>
read-only
Example:

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

updated_at
string<date-time>
read-only
Example:

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