Skip to main content
PATCH
Node.js

Authorizations

Authorization
string
header
required

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

Required scope: project:webhooks:write.

Path Parameters

id
string
required

Webhook identifier returned by Rewrite.

Example:

"748395130237498412"

Body

application/json
name
string | null

Updated friendly name. Send null to remove the current name.

Required string length: 1 - 32
Example:

"delivery-events-staging"

events
enum<string>[]

Updated event selection for the webhook.

Minimum array length: 1
Available options:
sms.otp,
message.sent,
message.batch,
message.queued,
message.failed,
message.canceled,
message.delivered,
message.received,
message.scheduled
Example:
secret
string

New signing secret to use for future deliveries.

Required string length: 16 - 128
Example:

"whsec_bmV3X3NlY3JldF92YWx1ZQ=="

endpoint
string<uri>

Updated destination URL for future deliveries.

Maximum string length: 255
Example:

"https://example.com/rewrite/webhooks/secondary"

isEnabled
boolean

Whether Rewrite should actively deliver events to this webhook.

Example:

false

delivery
object

Updated delivery tuning for timeout and retry behavior.

Response

200 - application/json

Successful response

ok
boolean
required
data
null
required