Update a webhook
PATCH
v2/webhooks/{webhookId}?accountId={accountId}Request
Use this request to update an existing webhook. Set theenabled field to true to make it available or false to make it unavailable.
You can’t change a webhook’s url or authorizationHeader. To change either, delete the webhook and create it again.
If you have a user-level API key, you need to specify an accountId to use this request.
If you have a product-level API key, you can choose to update this across all accounts by omitting the accountId query parameter.
Path parameters
string
required
The ID of the webhook that you want to update.Allowable values: An existing
webhookId (≤ 36 characters)Query parameters
string
The account ID to filter the response with. This is required if you have a user-level API key.Allowable values: An existing
accountId (≤ 36 characters)Request body schema
When provided, we use this to generate a hash-based message authentication code (HMAC) using the SHA-256 algorithm. We Base64 encode this signature. Every event notification you receive for this webhook will include an
x-em-signature header, if a shared secret has been provided. You can use this to verify the integrity and authenticity of the message.Allowable values: ≤ 36 charactersboolean
required
Whether or not the webhook should be enabled.Allowable values:
true, falseobject or null
Narrows which events the webhook receives. Currently this applies only to Roqqett checkout session events (
RoqqettCheckoutSessionCompleted, RoqqettCheckoutSessionCancelled and RoqqettCheckoutSessionAbandoned), and the only supported filter is checkoutId with the in operator. For example, { "checkoutId": { "in": ["6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12"] } } delivers events for that checkout only. Any other key is rejected with a 400 response. An event without a checkoutId, such as any non-Roqqett event, is never delivered to a webhook with a checkoutId filter. Set filters to null to remove a filter and receive events for every checkout again. Omit filters to leave it unchanged.Allowable values: A filters object whose checkoutId.in holds 1 to 100 checkout IDs, or nullResponse
If your request is successful, you’ll receive a200 response.