POST
Register a webhook

Authorizations

Authorization
string
header
required

Agent Token (rly_live_…), shown once at agent creation.

Body

application/json
url
string<uri>
required

Public HTTPS receiver URL.

Maximum string length: 2048
Pattern: ^https://
events
enum<string>[]

Omit to subscribe to every current event type.

Minimum array length: 1
Available options:
message.received,
message.edited,
message.unsent,
conversation.added,
conversation.updated,
conversation.removed,
reaction.added,
reaction.removed,
message.delivered,
message.read,
group.invite.completed,
group.invite.expired

Response

Webhook registered; store the signing secret now.

webhook
object
required
signing_secret
string
required

Base64-encoded 256-bit HMAC key. Returned only on create or rotation.

Pattern: ^whsec_
Example:

"whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"