Skip to main content
POST
Add a webhook

Authorizations

Authorization
string
header
required

Your API key, e.g. gr_live_…

Headers

Idempotency-Key
string
required

Your own unique id for this request (at most 255 characters). The same id and body within 24 hours answers the first answer again — never a second send or charge.

Maximum string length: 255

Body

application/json
url
string
required

An https link.

events
enum<string>[]
required
Available options:
message.sent,
message.delivered,
message.read,
message.failed,
message.received,
wallet.low,
number.quality_changed,
number.status_changed,
number.name_changed,
template.status_changed,
template.quality_changed,
template.created,
template.deleted,
campaign.started,
campaign.finished,
campaign.paused,
campaign.stopped

Response

Added; copy the secret now.

id
string
url
string
events
string[]
status
enum<string>
Available options:
ON,
OFF
created_at
string | null
secret
string