Endpoint
Provider record describing a webhook delivery destination and its delivery settings.
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 endpoint record. |
name | string | Optional | Display name of the webhook delivery destination. |
url | string | Optional | URL associated with the resource or outbound request. |
description | string | Optional | Human-readable description of the resource. |
status | string (ENDPOINT_STATUS_ACTIVE, ENDPOINT_STATUS_INACTIVE, ENDPOINT_STATUS_PAUSED, ENDPOINT_STATUS_PENDING) or integer (int32) | Optional | Current state of the webhook endpoint. |
secret | string | Optional | Secret associated with the webhook endpoint or deployed trigger. |
httpTimeout | integer (int32) | Optional | Timeout for an individual webhook HTTP delivery, in seconds. Minimum: -2147483648. Maximum: 2147483647. |
rateLimit | integer (int32) | Optional | Maximum delivery rate configured for the webhook endpoint. Minimum: -2147483648. Maximum: 2147483647. |
rateLimitDuration | string | Optional | Delivery-rate window returned as a seconds-suffixed duration string (for example, 60s). |
createdAt | string (date-time) | Optional | Time when this record was created. |
updatedAt | string (date-time) | Optional | Time when this record was last updated. |
Values of status
Lifecycle condition reported for a webhook delivery endpoint.
| Value | No. | Form | Meaning |
|---|---|---|---|
ENDPOINT_STATUS_ACTIVE | 1 | Canonical | The endpoint is marked active for webhook delivery. |
ENDPOINT_STATUS_INACTIVE | 2 | Canonical | The endpoint is marked inactive by the delivery backend. |
ENDPOINT_STATUS_PAUSED | 3 | Canonical | Delivery to the endpoint is paused. |
ENDPOINT_STATUS_PENDING | 4 | Canonical | The endpoint is pending activation in the delivery backend. |
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: DOC-API-MODEL-endpoint.