Skip to main content

List Webhook Events

GET 

/api/shippo/instances/:integration_instance/webhooks

Paginated log of inbound webhook events received from Shippo. processing_state is processed, failed (error is set) or pending. signature_valid is null when no HMAC secret is configured for the instance. The raw body is returned by Get Raw Webhook Event Payload.

Required scope: integrations:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Filtering: every filter[<column>] param below accepts an operator suffix, filter[<column>.<operator>]=<value>; list operators take a comma-separated value. Alternatively pass a nested AND/OR tree in filter_groups (base64-encoded JSON) — see that param.

Sorting: id, event_type, shippo_object_id, tracking_number, received_at, processed_at, attempts, created_at (default -id). Pagination: per_page defaults to 10.

Returns a standard paginated envelope: data[] plus current_page, from, to, per_page, total, last_page, first_page_url, last_page_url, next_page_url, prev_page_url, path and links. Returns 404 for an unknown instance.

Authentication: Requires a Bearer token.

Requires the integrations.show permission.

Request​

Responses​

OK

Response Headers
    Content-Type