Webhooks

Retrieve a webhook delivery

Retrieve one organization- and webhook-scoped delivery, including its payload and replay source.

get/webhooks/{id}/deliveries/{deliveryId}

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/webhooks/{id}/deliveries/{deliveryId}
  • 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)

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

Webhook delivery detail.

object'webhook_delivery' required
idstring required
event_idstring required
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' required
mode'live' | 'test' required

The API-key data plane that owns this resource. Test resources are isolated from live delivery, quota, suppression, and reputation.

status'pending' | 'delivered' | 'failed' required
attemptsinteger required
last_status_codeinteger nullable required
last_errorstring nullable required
created_atstring date-time required
delivered_atstring date-time nullable required
payloadobject required

The exact versioned webhook envelope sent to the endpoint.

next_attempt_atstring date-time nullable required
replayed_from_delivery_idstring nullable required

Changes

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