Skip to content

Replay a webhook delivery

Settings module

POST/webhook-deliveries/{id}/replaywebhookDeliveries.replay

Sends the delivery again with a fresh signature. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability org.webhooks.manage.
  • OAuth scopes: org.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

webhookDeliveries.replay: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the webhook delivery.

Response 202: WebhookDelivery

webhookDeliveries.replay: WebhookDelivery
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the webhook delivery.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
webhook_endpoint_idstring (uuid)YesIdentifier of the endpoint.
delivery_statusstringYesDelivery status. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
delivered_atstring (date-time) | nullYesWhen it was delivered.
domain_event_idstring (uuid)YesIdentifier of the domain event delivered; every attempt sends the same body built from it.
attempt_countintegerYesAttempts started.Constraints: range 0 to any
next_attempt_atstring (date-time)YesWhen the dispatcher may try next.
last_attempt_atstring (date-time) | nullYesWhen the latest attempt started.
last_response_statusinteger | nullYesHTTP status of the latest response; null when no response arrived.Constraints: range 100 to any
last_errorstring | nullYesNetwork or HTTP error of the latest failed attempt.Constraints: length 1 to 2000
replay_requested_bystring (uuid) | nullYesIdentifier 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"
}

Code samples

curl -X POST "$XOS_BASE_URL/webhook-deliveries/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/replay" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
const { data } = await xos.webhookDeliveries.replay("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.webhook_deliveries.replay("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos webhook-deliveries replay 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f