For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGet API key
DocumentationIntegrationsAPI Reference
DocumentationIntegrationsAPI Reference
  • API Reference
      • GETGet Webhook
      • POSTCreate Or Update Webhook
      • DELDelete Webhook
      • GETList Deliveries
      • GETDelivery Stats
      • GETAll Time Stats
      • POSTTest Webhook
LogoLogo
HomeGet API key
API Referencewebhooks

List Deliveries

GET
https://api.agentphone.ai/v1/webhooks/deliveries
GET
/v1/webhooks/deliveries
1const url = 'https://api.agentphone.ai/v1/webhooks/deliveries';
2const options = {
3 method: 'GET',
4 headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5 body: '{}'
6};
7
8try {
9 const response = await fetch(url, options);
10 const data = await response.json();
11 console.log(data);
12} catch (error) {
13 console.error(error);
14}
1{
2 "items": [
3 {
4 "id": "d4f8a9b2-3c7e-4f1a-9b2d-8e7f6a1c2b3d",
5 "messageId": "msg_987654321",
6 "eventType": "call.completed",
7 "channel": "voice",
8 "status": "delivered",
9 "httpStatus": 200,
10 "errorMessage": null,
11 "responseBody": "{\"success\":true,\"message\":\"Webhook received\"}",
12 "attemptCount": 3,
13 "lastAttemptAt": "2024-04-20T14:45:00Z",
14 "nextRetryAt": null,
15 "createdAt": "2024-04-20T14:30:00Z"
16 }
17 ],
18 "total": 25,
19 "offset": 0,
20 "limit": 50
21}
Get paginated webhook delivery attempts for all account webhooks.
Was this page helpful?
Previous

Delivery Stats

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitintegerOptional<=100Defaults to 50
offsetintegerOptional>=0Defaults to 0
hoursinteger or nullOptional1-168

Response

Successful Response
itemslist of objects
totalinteger
offsetinteger
limitinteger

Errors

422
Unprocessable Entity Error