v1

latestOpenAPI 3.1.0Apache 2.02026-07-2473175248.0 KB
14. Webhooks

Get subscription

get/webhooks/{webhookId}

Path parameters

webhookIdstring uuid required

The webhook identifier

Response

OK

webhookIdstring uuid

The ID of the webhook.

urlstring

The URL of the customer's webhook listener.

categoriesstring[]

The categories the customer wants to subscribe to.

eventTypesstring[]

The event types the customer wants to subscribe to.

signingCertificatestring

The public X509 certificate used to sign the webhook payload. The certificate is base64 encoded.

hmacSharedSecretKeystring

The HMAC secret key used to sign the webhook payload. Required when payloadVerificationMethod is HMAC. The key must be base64 encoded.

createdAtstring date-time

The date and time the webhook was created.

updatedAtstring date-time

The date and time when the webhook was last updated.

expiresAtstring date-time

The date and time the webhook expires.

payloadVerificationMethod'HMAC' | 'X509' | 'NONE'

Method to verify webhook payload integrity.