Webhook Events
By default, a webhook subscribes to all events occurring in or below an organization. To allow for more fine-grained event delivery you should subsribe the webhook to only deliver the specific events you need.
Message Events
Messaging events trigger a webhook with a Message and Conversation in its payload:
| Event | Description |
|---|---|
| message.create.*.* | A message in a conversation was affected (see below). |
| message.update | A message in a conversation was updated. |
| message.delete | A message was deleted. |
| message.error | A message error occurred. |
Message creation events are further augmented with the conversation type and the message type:
message.create.<conversation.type>.<message.type>Possible conversation types are:
- contact - A conversation with a consumer.
- bot - A team conversation initiated by a bot.
- agent - A team conversation initiated by an agent.
- system - A default system conversation for any agent.
As an example, these are the message.create events for a contact conversation:
| Event | Description |
|---|---|
| message.create.contact.chat | A chat message was added to a contact conversation. |
| message.create.contact.card | A card was added to a contact conversation. |
| message.create.contact.mention | A mention was added to a contact conversation. |
| message.create.contact.postback | A postback was added to a contact conversation. |
| message.create.contact.tag | A tag was added to a contact conversation. |
| message.create.contact.search | A search was added to a contact conversation. |
| message.create.contact.command | A command was added to a contact conversation. |
| message.create.contact.form | A form was added to a contact conversation. |
| message.create.contact.field | A field was added to a contact conversation. |
| message.create.contact.results | A results message was added to a contact conversation. |
| message.create.contact.report | A report was added to a contact conversation. |
| message.create.contact.status | A status message was added to a contact conversation. |
User Events
The following events trigger a webhook with a data.user and optionally a data.channel (for subscribe/unsubsribe events) in its payload:
| Event | Description |
|---|---|
| user.create | A new user was created. |
| user.invite | A user invite was sent. |
| user.accept | A user invite was accepted. |
| user.update | A user was updated. |
| user.delete | A user was deleted. |
| user.login | A user logged in. |
| user.logout | A user logged out. |
| user.subscribe | A user subscribed to a channel. |
| user.unsubscribe | A user unsubscribed from a channel. |
| user.error | An actionable user error occurred. |
Other Resource Events
All other resources trigger webhooks on resource creation, updates and deletion - such as the service.create event when a new service is created, or the article.update event whenever an article is updated. The webhook payload contains the corresponding resource objects; data.service and data.article in our examples.
The following resources events trigger webhooks:
| Resource | Events |
|---|---|
| bot.* | create, update, delete |
| botinstance.* | create, update, delete |
| conversation.* | create, update, delete, merge |
| organization.* | create, update, delete |
| contact.* | create, update, delete, merge |
| service.* | create, update, delete, error |
| channel.* | create, update, delete |
| form.* | create, update, delete |
| workflow.* | create, update, delete |
| article.* | create, update, delete |
| event.* | create, update, delete |
| file.* | create, update, delete |