List webhook deliveries

const url = 'https://saperly.com/api/v1/webhooks/deliveries';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "deliveries": [
    {
      "id": "d4f1a2b3-9c8e-4f7a-8b2d-3e5f6a7c9d01",
      "line_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "call_id": "f0e1d2c3-b4a5-6789-0abc-def123456789",
      "event_type": "call_started",
      "url": "https://hooks.saperly.com/webhook/receive",
      "status": "pending",
      "http_status": null,
      "error_message": null,
      "attempt_count": 1,
      "request_body": {
        "callSid": "CA1234567890abcdef",
        "from": "+12345678901",
        "to": "+10987654321",
        "timestamp": "2024-01-15T09:29:58Z"
      },
      "response_body": null,
      "duration_ms": null,
      "created_at": "2024-01-15T09:30:00Z"
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 0
}

Returns webhook delivery attempts with optional filtering.

Authentication

AuthorizationBearer

Send as Authorization: Bearer <your-key>. Obtain keys from the portal — prefix sk_live_ for production, sk_test_ for sandbox.

Query parameters

line_idstringOptionalformat: "uuid"

Filter by line ID

event_typeenumOptional

Filter by event type

Allowed values:

statusenumOptional

Filter by delivery status

Allowed values:

limitintegerOptional1-100Defaults to 50

Maximum number of results (1-100)

offsetintegerOptional>=0Defaults to 0

Number of results to skip

Response

List of webhook deliveries

deliverieslist of objects

totalinteger

limitinteger

offsetinteger

Errors

401

Unauthorized Error