Skip to content
Convor
Convor Docs
API ReferenceWebhooks

List webhook delivery history

Returns recent delivery attempts for one webhook, ordered from newest to oldest.

GET/api/webhooks/{id}/deliveries

Returns recent delivery attempts for one webhook, ordered from newest to oldest. Pagination uses the shared offset pagination query schema. limit defaults to 20 when omitted.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
webhooks:read
Module
Automation & API module (api_access)
Organization and site scope
Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior
Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Path Parameters

id*string

Path parameter. Unique identifier of this resource.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Query Parameters

limit?integer

Maximum number of resources to return.

Range1 <= value <= 100
Default20
page?integer

One-based page number.

Range1 <= value <= 9007199254740991
offset?integer

Zero-based number of resources to skip.

Range0 <= value <= 9007199254740991
Default0
search?string

Query parameter. Search text.

Lengthlength <= 200
status?string

Query parameter. Status. Allowed values: all, pending, delivering, success, failed, retrying, cancelled.

Default"all"

Value in

  • "all"
  • "pending"
  • "delivering"
  • "success"
  • "failed"
  • "retrying"
  • "cancelled"
sortBy?string

Query parameter. Sort by. Allowed values: eventType, status, statusCode, attempts, createdAt.

Default"createdAt"

Value in

  • "eventType"
  • "status"
  • "statusCode"
  • "attempts"
  • "createdAt"
sortDirection?string

Query parameter. Sort direction. Allowed values: asc, desc.

Default"desc"

Value in

  • "asc"
  • "desc"

Header Parameters

X-Project-Id?|

DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

{  "data": [    {      "id": "33333333-3333-4333-8333-333333333333",      "eventType": "conversation.created",      "statusCode": 200,      "response": "ok",      "status": "success",      "attempts": 1,      "createdAt": "2026-06-23T10:30:00.000Z"    }  ],  "pagination": {    "totalItems": 1,    "page": 1,    "pageSize": 20,    "hasNextPage": false,    "hasPrevPage": false  }}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/webhooks/11111111-1111-4111-8111-111111111111/deliveries' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/webhooks/11111111-1111-4111-8111-111111111111/deliveries", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Delete a webhook

Deletes an outbound webhook from the authenticated organization and stops future deliveries immediately.

List webhook events you can subscribe to

Returns the event names you can subscribe to when creating or updating an outbound webhook, with a short description and the editable data fields used to construct canonical test deliveries.

On this page

Request examplescurlJavaScript