Webhooks

List webhook deliveries

List delivery attempts for a webhook with optional status and event type filters.

get/webhooks/{id}/deliveries

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/webhooks/{id}/deliveries
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Query parameters

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

Filter by delivery status.

event_type'webhook.test' | 'message.received' | 'message.sent' | 'message.delayed' | 'message.delivered' | 'message.bounced' | 'message.complained' | 'mailbox.rule_matched' | 'mailbox.export.completed' | 'mailbox.export.failed' | 'domain.verified' | 'domain.verification_failed' | 'domain.degraded' | 'org.reputation_warning' | 'org.sending_throttled' | 'org.sending_suspended' | 'org.reputation_recovered' | 'reply.overdue' | 'conversation.needs_action' | 'calendar.event_starting' | 'booking.created' | 'subscriber.added' | 'newsletter.sent'

Filter by event type.

cursorstring

Opaque pagination cursor returned by the same list operation. Send it unchanged; do not parse, modify, or fabricate it.

limitinteger

Number of items to return (1-100, default 25).

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Paginated list of deliveries.

Changes

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