Deployments.ai Docs
Runtime

List the attempts of a webhook delivery

GET /v1/webhook-deliveries/{deliveryId}/attempts · SDK listWebhookDeliveryAttempts · CLI deployments webhook-delivery attempts

GET
/v1/webhook-deliveries/{deliveryId}/attempts

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}$

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

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

ListWebhookDeliveryAttemptsResponse

application/json
  1. response
attempts*array<>
nextCursor?|null
curl -X GET "https://example.com/v1/webhook-deliveries/string/attempts"
{  "attempts": [    {      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "version": 0,      "environmentId": "string",      "organizationId": "string",      "projectId": "string",      "attempt": 0,      "completedAt": "2019-08-24T14:15:22Z",      "durationMs": 0,      "error": "string",      "eventId": "string",      "manual": true,      "nextAttemptAt": "2019-08-24T14:15:22Z",      "object": "webhook-delivery-attempt",      "outcome": "delivered",      "responseBodyExcerpt": "string",      "responseCode": 0,      "responseHeaders": {        "property1": null,        "property2": null      },      "retentionExpiresAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "webhookDeliveryId": "string",      "webhookEndpointId": "string"    }  ],  "nextCursor": "string"}