Skip to main content

StoreWebhookRequest

Payload for registering a webhook endpoint.

urlurirequired

HTTPS URL that will receive webhook notifications. Must match one of your approved point-of-sale domains.

eventsstring[]required

List of webhook events to subscribe to. Duplicate values are rejected.

Possible values: [subscription-billing.charge-failed.v1, subscription-billing.charge-success.v1, subscription-billing.agreement-active.v1, subscription-billing.agreement-stopped.v1], >= 1

secretstringrequired

Shared secret used as the value of the Authorization header during webhook callback.

Possible values: non-empty and <= 2048 characters

StoreWebhookRequest
{
"url": "string",
"events": [
"subscription-billing.charge-failed.v1"
],
"secret": "string"
}