Get a webhook delivery
Módulo Settings
GET/webhook-deliveries/{id}webhookDeliveries.get
A webhook delivery attempt, replayable from Atlas. Returns one webhook delivery with its `ETag`. A webhook delivery the caller may not see returns 404.
- Requiere la capacidad org.settings.read.
- Alcances de OAuth: org.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the webhook delivery. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: WebhookDelivery
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the webhook delivery. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| webhook_endpoint_id | string (uuid) | Sí | Identifier of the endpoint. |
| delivery_status | string | Sí | Delivery status. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| delivered_at | string (date-time) | null | Sí | When it was delivered. |
| domain_event_id | string (uuid) | Sí | Identifier of the domain event delivered; every attempt sends the same body built from it. |
| attempt_count | integer | Sí | Attempts started.Restricciones: range 0 to any |
| next_attempt_at | string (date-time) | Sí | When the dispatcher may try next. |
| last_attempt_at | string (date-time) | null | Sí | When the latest attempt started. |
| last_response_status | integer | null | Sí | HTTP status of the latest response; null when no response arrived.Restricciones: range 100 to any |
| last_error | string | null | Sí | Network or HTTP error of the latest failed attempt.Restricciones: length 1 to 2000 |
| replay_requested_by | string (uuid) | null | Sí | Identifier of the person who replayed the event from Atlas. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"webhook_endpoint_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"delivery_status": "Delivered",
"delivered_at": "2026-10-08T14:30:00Z",
"domain_event_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"attempt_count": 1,
"next_attempt_at": "2026-10-08T14:30:00Z",
"last_attempt_at": "2026-10-08T14:30:00Z",
"last_response_status": 200,
"last_error": "Connection timed out.",
"replay_requested_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/webhook-deliveries/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.webhookDeliveries.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.webhook_deliveries.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos webhook-deliveries get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f