> For the complete documentation index, see [llms.txt](https://brpex.gitbook.io/brpex-crm/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://brpex.gitbook.io/brpex-crm/webhooks.md).

# Webhooks

Saiba como configurar e como funciona a integração dos webhooks.

### Recebimento de mensagens

Esse payload será recebido pelo seu webhook de recebimento:

```
{ 
    name: 'John Doe', 
    phone: '5511900000000', 
    text: 'Hello!', 
    file: 'https://mylink.com/image.jpg'
}
```

### Status de mensagens

Esse payload será recebido pelo seu webhook de status:

```
{
    partner_id: 1,
    message: 'sent',
    data: {
        name: 'John Doe',
        phone: '5511900000000',
        text: 'Hello!',
        file: 'https://mylink.com/image.jpg',
      }
}
```

### Campanhas por Lista de Transmissão (Broadcast) no WhatsApp

Esse payload será recebido pelo seu webhook de campanha tipo Broadcast:

```
{
    message: 'sent',
    data: {
        text: 'Hello!',
        file: 'https://mylink.com/image.jpg',
        scheduled_at: '2021-01-01 12:00:00',
      }
 }
```