Skip to main content

Webhook subscriptions

Overview​

Webhook subscriptions allow the merchant system to receive event notifications from Calypso without polling every object continuously.

Use this section to configure webhook subscriptions, understand delivery behavior, verify webhook signatures, and parse webhook payloads.

Guides​

GuideDescription
OverviewHow webhook subscriptions work and how Calypso retries delivery.
Delivery orderHow to handle unordered and duplicate webhook delivery.
Sign checkHow to verify webhook signatures.
Webhook payloadCommon webhook payload structure and subscription filters.
MethodPurpose
[POST] subscription/webhook/createCreate a webhook subscription.
[POST] subscription/webhookGet webhook subscriptions.
[POST] subscription/webhook/changeChange a webhook subscription.
[DELETE] subscription/webhookDelete a webhook subscription.
[DELETE] subscription/webhook/api-keys/regenerateRegenerate webhook signing keys.