Webhooks
List Webhook Deliveries
GET
header
x-api-key<token>Workspace API key, sent in the x-api-key header. Keys start with op_ and are created in the dashboard.
id*stringLength
1 <= lengthrange?stringNumber of days to cover. Defaults to 7. Your plan's log retention sets the maximum.
Value in
"1""3""7""30"status?stringComma-separated delivery statuses to include, such as success or failed.
q?stringReturns deliveries whose event type or event id starts with this text.
Length
length <= 120cursor?stringlimit?integerRange
1 <= value <= 50Deliveries
application/json- response
deliveries*array<>nextCursor*string|nullfacets*histogram*array<>Example Request
import { Configuration, WebhooksApi } from "@onepostly/sdk";const webhooksApi = new WebhooksApi( new Configuration({ apiKey: process.env.ONEPOSTLY_API_KEY }));const response = await webhooksApi.listWebhookDeliveries({ id: "dlv_1",});console.log(response);Example Response
{ "deliveries": [ { "id": "e8f9a0b1-c2d3-4e5f-8a6b-c7d8e9f0a1b2", "endpointId": "a1b2c3d4-e5f6-4a7b-8c9d-e0f1a2b3c4d5", "eventId": "post.published:b3e1a7c2-1234567890", "eventType": "post.published", "status": "success", "attemptCount": 1, "responseStatus": 200, "lastError": null, "createdAt": "2026-08-25T10:00:00.000Z", "deliveredAt": "2026-08-25T10:00:01.000Z" } ], "nextCursor": "string", "facets": { "status": [ { "status": "string", "count": 0 } ] }, "histogram": [ { "bucket": "string", "success": 0, "failed": 0 } ]}