Webhooks
Get Webhook Delivery Summary
Returns delivery counts for each webhook over the chosen window, as a series of time buckets plus totals.
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.
range?stringNumber of days to cover. Defaults to 7. Your plan's log retention sets the maximum.
Value in
"1""3""7""30"Per-endpoint delivery volume
application/json- response
rangeDays*integerbucketCount*integerendpoints*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.getWebhookDeliverySummary();console.log(response);Example Response
{ "rangeDays": 0, "bucketCount": 0, "endpoints": [ { "endpointId": "string", "total": 0, "failed": 0, "series": [ 0 ] } ]}