Events API · ShipMsg docs

API reference descriptions are provided in English to preserve the exact published contract.

GET /v1/accounts/{AC}/events

getV1AccountsByAcEventsPaginated200

List the events retained for your account, newest first, whether or not a webhook received them. Required scope: `events:read`.

Parameters

Parameters
Name	Type	Required	Description
`limit`	query · integer (1–100)
`cursor`	query · string (max 2048 chars)
`sort`	query · "createdAt" \| "-createdAt"
`type`	query · string (max 128 chars)
`createdAfter`	query · string (date-time)
`resource`	query · string (max 128 chars)
`endpointSid`	query · string (WH… SID)
`deliveryState`	query · "PENDING" \| "IN_FLIGHT" \| "SUCCEEDED" \| "FAILED" \| "DROPPED"
`AC`	path · string (AC… SID)	yes	Account SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

GET /v1/accounts/{AC}/events/{EV}

getV1AccountsByAcEventsByEv200

Fetch one event exactly as it was delivered to your webhooks. Required scope: `events:read`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes
`EV`	path · string (EV… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.