14. Webhooks
Create subscription
post/webhooks
Request body
urlstring required
The URL of the customer's webhook listener. Must be a valid URL.
categoriesstring[]
The categories the customer wants to subscribe to. Optional if specifying eventTypes.
eventTypesstring[]
The event types the customer wants to subscribe to. Optional if specifying categories.
signingCertificatestring
The public X509 certificate used to sign the webhook payload. Required when payloadVerificationMethod is X509. The certificate must be base64 encoded.
hmacSharedSecretKeystring
The HMAC secret key used to sign the webhook payload. Required when payloadVerificationMethod is HMAC. The key must be base64 encoded.
payloadVerificationMethod'HMAC' | 'X509' | 'NONE'
Method to verify webhook payload authenticity
Response
Created
webhookIdstring uuid
The ID of the webhook.
expiresAtstring date-time
The date and time the webhook expires.