Subscription
Webhook event selection and retry settings associated with an endpoint.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
id | string | Optional | Identifier of the subscription record. |
name | string | Optional | Display name of the webhook event subscription. |
endpointId | string | Optional | Identifier of the webhook endpoint receiving deliveries. |
eventTypes | Array of string | Optional | Event type names selected for the webhook subscription. |
filter | SubscriptionFilter | Optional | Selection criteria applied to the listing. |
retryConfig | RetryConfig | Optional | Retry policy applied to the webhook subscription. |
createdAt | string (date-time) | Optional | Time when this record was created. |
externalId | string | Optional | Client-supplied external subscription identifier. Empty when none was supplied. |
Where used
| Reference | Relationship |
|---|---|
| Create a webhook endpoint | POST /api/v1/webhooks/create-endpoint |
| Create a webhook subscription | POST /api/v1/webhooks/create-subscription |
| List webhook subscriptions | POST /api/v1/webhooks/list-subscriptions |
Download the public reference contract.
Document: DOC-API-MODEL-subscription.