Endpoint to update the properties of the subscription.

Update Subscription

The request body must contain the complete information about the subscription.

The following values can be updated: The URL used for the webhook, the event type applied to this URL and the secret, which is used to sign the payload. It is not possible to change the identification of the subscription.

Omitting properties from the request body (e.g. secret) will result in a validation error and return the status code 400.

SecurityJSON Web Token
Request
path Parameters
id
required
string = 20 characters ([A-Za-z0-9_-]{20})

Subscription ID received when creating a subscription.

Example: d8znR1k1_0Kw305BsoPT
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
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
200

OK. The subscription was updated.

400

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

401

Bad request because the client cannot be authorized.

403

Bad request because the client is not allowed to update the resource.

404

Bad request because the resource cannot be found.

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 occured while processing the request.

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