Section ID:
DOC-API-MODEL-schema-1fn66l17fv#overview
Subscription
Webhook event selection and retry settings associated with an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1fn66l17fv#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1fn66l17fv#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1fn66l17fv#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1fn66l17fv#field-idSection ID: DOC-API-MODEL-schema-1fn66l17fv#response-field-idid | string | Optional | Identifier of the subscription record. |
Section ID: DOC-API-MODEL-schema-1fn66l17fv#field-nameSection ID: DOC-API-MODEL-schema-1fn66l17fv#response-field-namename | string | Optional | Display name of the webhook event subscription. |
Section ID: DOC-API-MODEL-schema-1fn66l17fv#field-endpointidSection ID: DOC-API-MODEL-schema-1fn66l17fv#response-field-endpointidendpointId | string | Optional | Identifier of the webhook endpoint receiving deliveries. |
Section ID: DOC-API-MODEL-schema-1fn66l17fv#field-eventtypesSection ID: DOC-API-MODEL-schema-1fn66l17fv#response-field-eventtypeseventTypes | Array of string | Optional | Event type names selected for the webhook subscription. |
Section ID: DOC-API-MODEL-schema-1fn66l17fv#field-filterSection ID: DOC-API-MODEL-schema-1fn66l17fv#response-field-filterfilter | SubscriptionFilter | Optional | Event-body and header conditions used to select webhook events for this subscription. |
Section ID: DOC-API-MODEL-schema-1fn66l17fv#field-retryconfigSection ID: DOC-API-MODEL-schema-1fn66l17fv#response-field-retryconfigretryConfig | RetryConfig | Optional | Retry policy applied to the webhook subscription. |
Section ID: DOC-API-MODEL-schema-1fn66l17fv#field-createdatSection ID: DOC-API-MODEL-schema-1fn66l17fv#response-field-createdatcreatedAt | string (date-time) | Optional | Time when this record was created. |
Section ID: DOC-API-MODEL-schema-1fn66l17fv#field-externalidSection ID: DOC-API-MODEL-schema-1fn66l17fv#response-field-externalidexternalId | string | Optional | Client-supplied external subscription identifier. Empty when none was supplied. |
Section ID: DOC-API-MODEL-schema-1fn66l17fv#field-updatedatSection ID: DOC-API-MODEL-schema-1fn66l17fv#response-field-updatedatupdatedAt | string (date-time) | Optional | Time when this record was last updated; equals created_at until the first accepted update. |
Where used
Section ID: DOC-API-MODEL-schema-1fn66l17fv#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 ID: DOC-API-MODEL-schema-1fn66l17fv