1. Visão geral sobre Webhooks
Sempre que ocorre um evento importante, nós disparamos uma notificação para seu servidor. Essas notificações são chamadas de webhooks. É possível configurar varios endpoints e escolher quais eventos serão disparados . O objeto webhook contêm os seguintes atributos:
| Atributo | Tipo | Descrição |
|---|---|---|
| id | String | Identificador do webhook |
| channel | String | Canal referente ao webhook. Valores possíveis: telegram sms messenger |
| type | String | Tipo da mensagem. Valores possíveis: text audio video image document |
| status | String | Status da mensagem. Valores possíveis: |
| to | String | Quem recebeu a mensagem. |
| from | String | Quem enviou a mensagem. |
| answeredDate | String | Data |
| content | String | Conteúdo da mensagem. |
| contactUser | Object | Dados do contato do usuário que esta interagindo com a integração. |
| contactBusiness | Object | Dados da sua integração. |
| integrationId | String | Identificador da sua integração. |
Object contactUser and contactBusiness
| Atributo | Tipo | Descrição |
|---|---|---|
| number | String | Número do contato. |
| name | String | Nome do contato. |
| profileImageUrl | String | Url da imagem do contato. |
2. Eventos de webhook
| Atributos | Descrição |
|---|---|
| SENT | Quando a mensagem é enviada através do Moorse ao usuário. |
| DELIVERED | Quando a mensagem enviada através do Moorse é entregue ao usuário. |
| READ | Quando a mensagem enviada através do Moorse é lida pelo usuário. |
| RECEIVED | Quando o moorse recebe uma mensagem do usuário. |
| FAILED | Erro ao enviar uma mensagem. |
3. Exemplo de webhook
{
"id": "bc952277-c9dd-4d1f-a738-b1dbbab85f07",
"channel": "whatsapp",
"type": "text",
"status": "RECEIVED",
"to": "5511975923164",
"from": "5511888888888",
"answeredDate": "2021-09-12T09:35:09.000-0300",
"content": "oi",
"contactUser": {
"number": "5511888888888",
"name": "Usuario de teste",
"profileImageUrl": "https://pps.whatsapp.net/v/t61.24694-24/137564399_309884113798572_87473243472495250_n.jpg?ccb=11-4&oh=8a05f65ee033adbd201bf2f4c44c274e&oe=614268E5"
},
"contactBusiness": {
"number": "5511975923164",
"name": "Moorse.io",
"profileImageUrl": "https://pps.whatsapp.net/v/t61.24694-24/204014957_231584828908244_7955484006279821067_n.jpg?ccb=11-4&oh=4d8c2ba0d44c4913d007e6dbeae377c6&oe=61425758"
},
"integrationId": "40dc604f-5a51-4633-b05a-a2f94a44c772"
}