Skip to main content
GET
Node.js

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer rw_....

Required scope: project:write.

Path Parameters

id
string
required

Webhook identifier returned by Rewrite.

Example:

"748395130237498412"

Query Parameters

after
string

Cursor for forward pagination. Send exactly one of after or before when paginating.

Example:

"748395130237498412"

before
string

Cursor for backward pagination. Send exactly one of after or before when paginating.

Example:

"748395130237498412"

limit
integer

Page size. Backend cursor schemas validate this between 2 and the route-specific maximum.

Required range: 2 <= x <= 100
type
enum<string>

Filter by webhook event type.

Available options:
sms.otp,
message.sent,
message.batch,
message.queued,
message.failed,
message.canceled,
message.delivered,
message.received,
message.scheduled
status
enum<string>

Filter by webhook delivery status.

Available options:
FAILED,
SUCCESS
code
integer

Filter by HTTP status code.

Required range: 100 <= x <= 600
attempt
integer

Filter by delivery attempt number.

Required range: 1 <= x <= 5
messageId
string

Filter by message identifier.

Example:

"748395130237498412"

Response

200 - application/json

Successful response

ok
boolean
required
data
object[]
required
cursor
object
required