Deployments.ai Docs
Runtime

List webhook deliveries

GET /v1/webhook-deliveries · SDK listWebhookDeliveries · CLI deployments webhook-delivery list

GET
/v1/webhook-deliveries

Requires webhooks:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length <= 4096
limit?integer

Maximum number of resources to return.

Range1 <= value <= 100
webhookId?string

Only return deliveries for this webhook subscription.

status?string

Only return deliveries in this status.

Value in"delivered""failed""pending""retrying""sending"

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

ListWebhookDeliveriesResponse

application/json
  1. response
deliveries*array<>
nextCursor?|null
curl -X GET "https://example.com/v1/webhook-deliveries"
{  "deliveries": [    {      "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"    }  ],  "nextCursor": "string"}