List Webhook Events
GET/api/starshipit/integration-instances/:integration_instance/webhook-events
Returns a paginated list of inbound webhook events received from StarShipIt for this instance, newest first.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Each event records the raw payload, whether its signature was valid, the extracted order_number / tracking_number / tracking_status, and its processing state: processed + processed_at when handled successfully, or error_message when processing failed (failed events can be re-queued via the retry endpoint).
tracking_status values: Printed, Dispatched, InTransit, OutForDelivery, Delivered, PickupInStore, AttemptedDelivery, Exception, AwaitingCollection, Cancelled, Manifested, ReturnPickupPrinted, ReturnDropoffPrinted, DroppedOff, ReturnLink, ReturnLabel.
Filtering uses operator-aware syntax: filter[column.operator]=value (text operators: contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, ends_with, is_empty, is_not_empty; datetime operators include between). A bare filter[column]=value acts as is.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.