Automation and events
Webhook deliveries
Webhook deliveries in Webhooks — Micro TypeScript reference.
Reference for TypeScript SDK 0.14.0.
Release source · Setup and client configuration
list
GET /v2/webhooks/{teamId}/{webhookId}/deliveries
client.webhooks.deliveries.list(webhookID, { ...params }) -> DeliveryListResponseAn endpoint's deliveries, newest first, with optional status / type / time-range filters and cursor pagination.
get
GET /v2/webhooks/{teamId}/{webhookId}/deliveries/{deliveryId}
client.webhooks.deliveries.get(deliveryID, { ...params }) -> WebhookDeliveryDetailA single delivery plus its full attempt timeline (including async retries).
Parameter and response types
These declarations show the request parameters and response shapes used by the methods above.
DeliveryListResponse
export interface DeliveryListResponse {
data: Array<WebhooksAPI.WebhookDelivery>;
/**
* Pass as `cursor` to fetch the next page; null when there are no more.
*/
next_cursor?: string | null;
}DeliveryListParams
export interface DeliveryListParams {
/**
* Path param
*/
teamId?: string;
/**
* Query param: Only deliveries at or after this ISO-8601 timestamp.
*/
after?: string;
/**
* Query param: Only deliveries at or before this ISO-8601 timestamp.
*/
before?: string;
/**
* Query param: Opaque cursor from a previous response's `next_cursor`.
*/
cursor?: string;
/**
* Query param: Page size (1–100, default 25).
*/
limit?: number;
/**
* Query param: Filter by outcome.
*/
status?: 'success' | 'failed';
/**
* Query param: Filter by run type. Defaults to `delivery` (event deliveries). Pass
* `all` to include verification handshakes.
*/
type?: 'delivery' | 'verification' | 'all';
}DeliveryGetParams
export interface DeliveryGetParams {
teamId?: string;
webhookId: string;
}Deliveries
export declare namespace Deliveries {
export {
type DeliveryListResponse as DeliveryListResponse,
type DeliveryListParams as DeliveryListParams,
type DeliveryGetParams as DeliveryGetParams,
};
}