Endpoint to create a new subscription.

Creates a new webhook subscription accessible only to the client.

SecurityJSON Web Token
Request
header Parameters
Authorization
required
string

For each request, a valid access token must be provided in the Authorization header. See Authentication API for obtaining a valid token.

Request Body schema: application/json
required
url
required
string <url>

HTTP URL to execute the webhook call with the POST method.

event_type
required
string

Type of the event to process by calling the API endpoint.

secret
required
string >= 64 characters

Parameter given by the client to sign their payloads. Recommended to be unique for each URL.

Responses
201

The subscription was created.

400

Bad request due to a client error in path parameters, header or body.

405

Bad request because the HTTP method is not allowed.

406

Bad request because the server cannot produce a response matching the list of acceptable values.

415

Bad request because the payload format is not supported.

500

An internal server error occurred while processing the request.

post/webhook/management/v1
Request samples
application/json
{}
Response samples
application/json
{
  • "id": "d8znR1k1_0Kw305BsoPT",
  • "url": "https://api.merchant.com/event",
  • "event_type": "INVOICE_INVOICE",
  • "secret": "6GHbLH4d1Nx3eIs5CyLHCW4HuFi1qttpNSDawHKHlW7kurTpaddarwEKDWUI59IU"
}