Skip to Content
API keys are issued to organizations with a signed BAA. Request API access →
API referenceWebhook events

Webhook events

Every delivery shares one envelope. The payload changes with the event type and carries IDs, not message content, so fetch the resource with the API when you need more. See Webhooks to set up an endpoint and verify signatures.

The event envelope

idUUIDRequired

Stable event UUID used for consumer deduplication.

typeconversation.message.created, message.reaction.created, message.reaction.deleted, conversation.participant.added, conversation.participant.removed, export.readyRequired
occurred_attimestampRequired
organization_idUUIDRequired
delivery_attemptintegerRequired
payloadobjectRequired

Event-specific fields. See Webhooks for each event’s payload.

conversation.message.created

A message was sent in a conversation your app user participates in, including messages your app user sent.

Payload

conversation_idUUIDRequired
message_idUUIDRequired
sender_idUUIDRequired

message.reaction.created

Someone added an emoji reaction to a message in one of your conversations.

Payload

conversation_idUUIDRequired
message_idUUIDRequired
user_idUUIDRequired
emojistringRequired

message.reaction.deleted

Someone removed their reaction from a message.

Payload

conversation_idUUIDRequired
message_idUUIDRequired
user_idUUIDRequired
emojistringRequired

conversation.participant.added

A user joined one of your conversations.

Payload

conversation_idUUIDRequired
user_idUUIDRequired

conversation.participant.removed

A user left or was removed from one of your conversations. If it was your app user, you receive no further events for that conversation.

Payload

conversation_idUUIDRequired
user_idUUIDRequired

export.ready

An export you started has finished. Fetch the export to get its short-lived download_url.

Payload

export_idUUIDRequired
conversation_idUUIDRequired
statusstringRequired
Last updated on
Retrieve an export