Section ID:
Values of
DOC-API-MODEL-schema-1ffl20kv2k#overview
Endpoint
Provider record describing a webhook delivery destination and its delivery settings.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#field-idSection ID: DOC-API-MODEL-schema-1ffl20kv2k#response-field-idid | string | Optional | Identifier of the endpoint record. |
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#field-nameSection ID: DOC-API-MODEL-schema-1ffl20kv2k#response-field-namename | string | Optional | Display name of the webhook delivery destination. |
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#field-urlSection ID: DOC-API-MODEL-schema-1ffl20kv2k#response-field-urlurl | string | Optional | URL of the webhook delivery destination. |
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#field-descriptionSection ID: DOC-API-MODEL-schema-1ffl20kv2k#response-field-descriptiondescription | string | Optional | Human-readable description of the resource. |
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#field-statusSection ID: DOC-API-MODEL-schema-1ffl20kv2k#response-field-statusstatus | string (ENDPOINT_STATUS_ACTIVE, ENDPOINT_STATUS_INACTIVE, ENDPOINT_STATUS_PAUSED, ENDPOINT_STATUS_PENDING) or integer (int32) | Optional; explicit presence | Current state of the webhook endpoint. |
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#field-secretSection ID: DOC-API-MODEL-schema-1ffl20kv2k#response-field-secretsecret | string | Optional | Secret associated with the webhook endpoint. |
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#field-httptimeoutSection ID: DOC-API-MODEL-schema-1ffl20kv2k#response-field-httptimeouthttpTimeout | string (int64) | Optional | Timeout for an individual webhook HTTP delivery, in seconds. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#field-ratelimitSection ID: DOC-API-MODEL-schema-1ffl20kv2k#response-field-ratelimitrateLimit | string (int64) | Optional | Maximum delivery rate configured for the webhook endpoint. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#field-ratelimitdurationSection ID: DOC-API-MODEL-schema-1ffl20kv2k#response-field-ratelimitdurationrateLimitDuration | string | Optional | Delivery-rate window returned as a seconds-suffixed duration string (for example, 60s). |
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#field-createdatSection ID: DOC-API-MODEL-schema-1ffl20kv2k#response-field-createdatcreatedAt | string (date-time) | Optional | Time when this record was created. |
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#field-updatedatSection ID: DOC-API-MODEL-schema-1ffl20kv2k#response-field-updatedatupdatedAt | string (date-time) | Optional | Time when this record was last updated. |
Values of status
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#response-values-status
Enums
Lifecycle condition reported for a webhook delivery endpoint.
| Value | No. | Form | Meaning |
|---|---|---|---|
ENDPOINT_STATUS_ACTIVE | 0 | Canonical | The endpoint is marked active for webhook delivery. |
ENDPOINT_STATUS_INACTIVE | 1 | Canonical | The endpoint is marked inactive by the delivery backend. |
ENDPOINT_STATUS_PAUSED | 2 | Canonical | Delivery to the endpoint is paused. |
ENDPOINT_STATUS_PENDING | 3 | Canonical | The endpoint is pending activation in the delivery backend. |
Where used
Section ID: DOC-API-MODEL-schema-1ffl20kv2k#where-used
| Reference | Relationship |
|---|---|
| Create a webhook endpoint | POST /api/v1/webhooks/create-endpoint |
| List webhook endpoints | POST /api/v1/webhooks/list-endpoints |
| Update a webhook endpoint | POST /api/v1/webhooks/update-endpoint |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1ffl20kv2k