Node.js
import { Rewrite } from '@rewritetoday/sdk';
const rewrite = new Rewrite(process.env.REWRITE_API_KEY!);
const { data, error } = await rewrite.webhooks.create({
name: 'delivery-events',
endpoint: 'https://example.com/rewrite/webhooks',
events: ['message.sent', 'message.failed', 'sms.otp'],
});
if (error) throw error;{
"ok": true,
"data": {
"id": "748395130237498750",
"secret": "whsec_dGVzdF9zZWNyZXRfdmFsdWU=",
"sandbox": false,
"createdAt": "2026-03-20T14:22:31.562Z"
}
}Webhooks
Create a webhook
Create a webhook and choose which Rewrite events should be delivered to it.
POST
/
webhooks
Node.js
import { Rewrite } from '@rewritetoday/sdk';
const rewrite = new Rewrite(process.env.REWRITE_API_KEY!);
const { data, error } = await rewrite.webhooks.create({
name: 'delivery-events',
endpoint: 'https://example.com/rewrite/webhooks',
events: ['message.sent', 'message.failed', 'sms.otp'],
});
if (error) throw error;{
"ok": true,
"data": {
"id": "748395130237498750",
"secret": "whsec_dGVzdF9zZWNyZXRfdmFsdWU=",
"sandbox": false,
"createdAt": "2026-03-20T14:22:31.562Z"
}
}Authorizations
Send your API key as Authorization: Bearer rw_....
Required scope: project:webhooks:write.
Body
application/json
Event types that should be delivered to this webhook.
Minimum array length:
1Available options:
sms.otp, message.sent, message.batch, message.queued, message.failed, message.canceled, message.delivered, message.received, message.scheduled Example:
[ "message.sent", "message.failed", "message.received", "sms.otp" ]
Must be HTTPS in production. http://localhost/... is also accepted. Query strings and fragments are rejected.
Maximum string length:
255Example:
"https://example.com/rewrite/webhooks"
Friendly name shown in the dashboard and logs.
Required string length:
1 - 32Example:
"delivery-events"
Accepted formats: whsec_<base64>, raw base64, or legacy rw_whsec_....
Required string length:
16 - 128Example:
"whsec_dGVzdF9zZWNyZXRfdmFsdWU="
Optional delivery tuning for timeout and retry behavior.
Show child attributes
Show child attributes