Deployments.ai Docs
Runtime

Show a webhook delivery

GET /v1/webhook-deliveries/{deliveryId} · SDK getWebhookDelivery · CLI deployments webhook-delivery show

GET
/v1/webhook-deliveries/{deliveryId}

Requires webhooks:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Path Parameters

deliveryId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

WebhookDeliveryResponse

application/json
  1. response
createdAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
updatedAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
version*number|||
environmentId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
organizationId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
projectId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
aggregateId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
aggregateType*string
aggregateVersion*number|||
attempt*number|||
eventId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
eventType*string
failureReason?string
Value in"attempts-exhausted""endpoint-inactive""event-unavailable""non-retryable""organization-suspended"
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
lastAttemptAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
lastError?string
manualRetryRequestedAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
maxAttempts*number|||
nextAttemptAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
object*"webhook-delivery"
Value in"webhook-delivery"
responseCode?number|||
responseHeaders?
retentionExpiresAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
status*string
Value in"delivered""failed""pending""retrying""sending"
webhookEndpointId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
curl -X GET "https://example.com/v1/webhook-deliveries/string"
{  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0,  "environmentId": "string",  "organizationId": "string",  "projectId": "string",  "aggregateId": "string",  "aggregateType": "string",  "aggregateVersion": 0,  "attempt": 0,  "eventId": "string",  "eventType": "string",  "failureReason": "attempts-exhausted",  "id": "string",  "lastAttemptAt": "2019-08-24T14:15:22Z",  "lastError": "string",  "manualRetryRequestedAt": "2019-08-24T14:15:22Z",  "maxAttempts": 0,  "nextAttemptAt": "2019-08-24T14:15:22Z",  "object": "webhook-delivery",  "responseCode": 0,  "responseHeaders": {    "property1": null,    "property2": null  },  "retentionExpiresAt": "2019-08-24T14:15:22Z",  "status": "delivered",  "webhookEndpointId": "string"}