Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Webhooks

Update a webhook key secret

Updates the HMAC secret for a webhook endpoint.

The HMAC secret is a key used to create an encrypted hash of the webhook payload, ensuring the integrity and authenticity of messages sent to your webhook URL.

Ensure your server can decrypt messages with the new HMAC key before updating. Discard the old HMAC secret after the update is completed.

Visit our Message Security section for more details on how to use this HMAC secret.

post/webhooks/keys

Request body

urlstring uri required

The URL associated with the webhook endpoint.

hmacSecretstring required

The new HMAC secret key for signing webhook payloads.

Example request

{
  "url": "https://example.com/webhook-endpoint",
  "hmacSecret": "newHmacSecret123456789"
}

Response

OK

urlstring

The URL of the webhook endpoint.

actionstring

The action performed by the API.

resultstring

The result of the operation.

Example response

{
  "url": "https://example.com/webhook-endpoint",
  "action": "webhooks.update",
  "result": "success"
}