Webhooks

List webhook deliveries

Returns retained delivery logs visible to the API key, newest first. Results are capped to the 1000 most recent matching deliveries.

get/v1/webhook-deliveries

Request

  • Base URL: https://api.postzen.dev
  • URL: https://api.postzen.dev/v1/webhook-deliveries
  • Auth: HTTP bearer

Query parameters

webhookIdstring

Filter by webhook endpoint id.

event'post.scheduled' | 'post.published' | 'post.partially_failed' | 'post.failed' | 'post.cancelled' | 'post.platform.published' | 'post.platform.failed' | 'post.external.created' | 'account.connected' | 'account.needs_reauth' | 'account.disconnected' | 'analytics.synced' | 'conversation.started' | 'message.received' | 'message.sent' | 'comment.received' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'webhook.test'

Webhook event type. See the Webhook Events section for each event's trigger and payload. Receivers should tolerate additional event types in future API versions.

Filter by webhook event type.

status'pending' | 'retrying' | 'delivered' | 'failed'

Filter by delivery status.

dateFromstring date-time

Only include deliveries created at or after this ISO 8601 timestamp.

dateTostring date-time

Only include deliveries created at or before this ISO 8601 timestamp. Must be later than dateFrom.

pageinteger

1-based page number.

limitinteger

Page size.

Response

Webhook deliveries returned.

Changes

No recorded changes to this operation across all 1 revision of this API.