Eventos Disponíveis

Estamos em processo de melhorias da nossa documentação, em breve estaremos incluindo mais eventos com seus devidos exemplos.

`instance.connected`

A instância foi conectada com sucesso e está pronta para envio e recebimento de mensagens.

Exemplo

{
  "created_at": "2024-03-14T23:33:13.623Z",
  "data": {
    "id": "551112341234",
    "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
  },
  "id": "so9lv3u3pu81he8gumfa4", // ID da notificação
  "type": "instance.connected"
}

`instance.disconnected`

A instância foi desconectada com sucesso.

Algumas vezes a desconexão pode acontecer devido a falhas internas do Whatsapp, internamente temos estrategias de recuperação, nestes casos o evento instance.connected pode ser emitido alguns segundos depois do evento de desconexão.

Exemplo

{
  "created_at": "2024-09-14T13:51:49.224Z",
  "data": {
    "name": "Account Name",
    "id": "551112341234",
    "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
    "reason": {
      "code": "logout",
      "message": "The instance has been logged out."
    }
  },
  "id": "682jcucv557qt0yarqivh",
  "type": "instance.disconnected"
}

`message.received`

Uma mensagem foi recebida na instância. Para detalhamento completo de como é o formato do objeto mensagem verifique na página Estrutura dos eventos > Mensagem

Exemplo: Mensagem de texto

{
  "created_at": "2024-09-14T13:55:46.420Z",
  "data": {
    "content": {
      "text": "Oi"
    },
    "id": "3AAB4DA4297176B74E38",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2024-09-14T13:55:46.000Z",
    "type": "text"
  },
  "id": "y66lhiw5la6z3r8f1urm0",
  "type": "message.received"
}

Exemplo: Mensagem com imagem

{
  "created_at": "2025-01-30T13:28:15.771Z",
  "data": {
    "content": {
      "view_once": false,
      "media": {
        "url": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
      },
      "text": "My image caption"
    },
    "id": "3EB0AA6B4A8B13C4CA44E4",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2025-01-30T13:28:15.000Z",
    "type": "image"
  },
  "id": "sepu74f9o9c3y8gq0ikbl",
  "type": "message.received"
}

Exemplo: Mensagem com áudio

{
  "created_at": "2025-01-30T13:28:15.771Z",
  "data": {
    "content": {
      "view_once": false,
      "media": {
        // URL para arquivo de áudio MP3
        "url": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
      },
      "text": ""
    },
    "id": "3EB0AA6B4A8B13C4CA44E4",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2025-01-30T13:28:15.000Z",
    "type": "audio"
  },
  "id": "sepu74f9o9c3y8gq0ikbl",
  "type": "message.received"
}

Exemplo: Mensagem de localização

{
  "created_at": "2025-01-30T13:31:56.534Z",
  "data": {
    "content": {
      "location": {
        "address": "São Paulo, SP",
        "latitude": -9.123456789123456,
        "longitude": -40.123456789123456,
        "mode": "static",
        "name": "Centro de Artes"
      }
    },
    "id": "3A8A44190C6F468A1E90",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2025-01-30T13:31:56.000Z",
    "type": "location"
  },
  "id": "8qmaixneh95c4vb6xm89k",
  "type": "message.received"
}

Exemplo: Mensagem com Sticker

{
  "created_at": "2025-01-30T13:36:41.856Z",
  "data": {
    "content": {
      "media": {
        "metadata": {
          "animated": true
        },
        "url": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
      }
    },
    "id": "3AB26376707099366558",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2025-01-30T13:36:41.000Z",
    "type": "sticker"
  },
  "id": "3niukssdl9ca2qktbv9u6",
  "type": "message.received"
}

Exemplo: Mensagem com GIF ou Vídeo

{
  "created_at": "2025-01-30T13:39:37.156Z",
  "data": {
    "content": {
      "view_once": false,
      "media": {
        "metadata": {
          "duration": 1,
          "playback": true
        },
        "url": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
      },
      "text": "My video/gif caption"
    },
    "id": "3AB703F9740E34B5E110",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2025-01-30T13:39:36.000Z",
    "type": "video"
  },
  "id": "jlmnxdp63p03wrv2ynepn",
  "type": "message.received"
}

Exemplo: Mensagem "quoted" (ou resposta) para outra mensagem

Observe a propriedade data.content.quoted, ela representa a citação ou marcação de quem está respondendo e tem o mesmo formato de uma message.received.

{
  "created_at": "2025-02-02T21:18:28.437Z",
  "data": {
    "content": {
      "view_once": false,
      "quoted": {
        "content": {
          "text": "🙏"
        },
        "id": "3EB0E8FE1559DADE848EF5",
        "recipient": {
          "name": "Recipient Name",
          "id": "551112341234",
          "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
          "type": "chat"
        },
        "sender": {
          "name": "Sender Name",
          "id": "551112341234",
          "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
        },
        "type": "text"
      },
      "text": "My reply to quoted message"
    },
    "id": "3EB090C9F062EF62F1D924",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2025-02-02T21:18:28.000Z",
    "type": "text"
  },
  "id": "wy43uruj26ylse1cs38ps",
  "type": "message.received"
}

Exemplo: Mensagem resposta à um status

Observe que o status respondido ficará dentro de data.content.quoted que terá o mesmo formato de uma message.received, a grande diferença aqui é que você verá uma nova propriedade data.content.quoted.origin sendo o seu valor igual à status.

Em alguns casos você pode encontrar uma variação do payload contendo uma propriedade para status que são postado em formato de texto, seu valor representará a cor do fundo (background), contendo no formato decimal, hexadecimal com e sem o canal alfa (transparência).

{
  "background_color": {
    "decimal": 4283864831,
    "hex_argb": "#FF5696FF", // com o canal alfa
    "hex_rgb": "#5696FF" // sem o canal alfa
  }
}

{
  "created_at": "2025-02-02T21:14:47.330Z",
  "data": {
    "content": {
      "view_once": false,
      "quoted": {
        "content": {
          "view_once": false,
          "origin": "status",
          "media": {
            "url": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
          },
          "text": "My status caption"
        },
        "id": "E7531155884C68EAC1F3F1774E2CABD2",
        "recipient": {
          "name": "Recipient Name",
          "id": "551112341234",
          "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
          "type": "chat"
        },
        "sender": {
          "name": "Sender Name",
          "id": "551112341234",
          "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
        },
        "type": "image"
      },
      "text": "Answering to the posted status XYZ"
    },
    "id": "3EB02ADDF16B28F7CA3753",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2025-02-02T21:14:46.000Z",
    "type": "text"
  },
  "id": "p7ly4vp5jrlsw3yfm7pt2",
  "type": "message.received"
}

Exemplo: Mensagem com vcard (contatos)

Se a propriedade waid (ela pode ser ausente) estiver presente dentro de data.content.contacts.phones isso pode siginificar que o telefone / contato recebido tem um whatsapp válido.

{
  "created_at": "2025-02-02T21:33:48.334Z",
  "data": {
    "content": {
      "contacts": [
        {
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Test;Contato;;;\nFN:Contato Test\nTEL;type=CELL;waid=5511123451234:+55 11 12345-1234\nEND:VCARD",
          "display_name": "Contato Test",
          "first_name": "Contato",
          "last_name": "Test",
          "phones": [
            {
              "formatted_value": "+55 11 12345-1234",
              "waid": "5511123451234"
            }
          ]
        }
      ]
    },
    "id": "3EB0B2B79F42613ACE4E",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2025-02-02T21:33:47.000Z",
    "type": "vcard"
  },
  "id": "u0hyeyfkiwfmjdwf937cs",
  "type": "message.received"
}

Exemplo: Mensagem com botões

As mensagens com botões poderão chegar com os tipos text, image ou video e sempre acompanhada da propriedade buttons em seu conteudo (data.content).

{
  "created_at": "2025-03-08T13:18:10.215Z",
  "data": {
    "content": {
      "buttons": [
        {
          "id": "2ec4cf13-6c5c-48b3-af42-cc572d22c2b2",
          "label": "Sim",
          "type": "reply"
        },
        {
          "id": "ccebc70b-aefd-492f-a19c-94b1384964be",
          "label": "Não",
          "type": "reply"
        }
      ],
      "text": "Você gostaria de informar seu endereço agora?"
    },
    "id": "3EB0303793FBDDACB97101",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2025-03-08T13:18:08.000Z",
    "type": "text"
  },
  "id": "n0co5zard1myk7wx07cks",
  "type": "message.received"
}

Exemplo: Mensagem resposta à botões

Assim como o exemplo acima, o tipo de mensagem chegará como text, video ou image porém a propriedade button_reply (data.button_reply) mostrará qual botão o usuário pressionou.

{
  "created_at": "2025-03-08T13:43:34.060Z",
  "data": {
    "content": {
      "text": "Sim",
      "button_reply": {
        "label": "Sim",
        "type": "reply",
        "id": "2ec4cf13-6c5c-48b3-af42-cc572d22c2b2"
      },
      "quoted": {
        "content": {
          "buttons": [
            {
              "label": "Sim",
              "type": "reply",
              "id": "2ec4cf13-6c5c-48b3-af42-cc572d22c2b2"
            },
            {
              "label": "Não",
              "type": "reply",
              "id": "ccebc70b-aefd-492f-a19c-94b1384964be"
            }
          ],
          "text": "Você gostaria de informar seu endereço agora?"
        },
        "id": "3EB0303793FBDDACB97101",
        "recipient": {
          "name": "Recipient Name",
          "id": "551112341234",
          "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
          "type": "chat"
        },
        "sender": {
          "name": "Sender Name",
          "id": "551112341234",
          "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
        },
        "sent_at": "2025-03-08T13:18:08.000Z",
        "type": "text"
      }
    },
    "id": "A09627FC7D6444122AFF8AB0AB59BA6A",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2025-03-08T13:43:31.000Z",
    "type": "text"
  },
  "id": "kckozfp7fpn4cfxfbsglu",
  "type": "message.received"
}

Exemplo: Mensagem com lista de opções

{
  "created_at": "2025-03-08T17:54:47.475Z",
  "data": {
    "content": {
      "list_options": {
        "button_label": "Abrir lista de opções",
        "sections": [
          {
            "description": null,
            "options": [
              {
                "description": "Descrição, opção 1",
                "id": "1",
                "title": "Opção 1"
              },
              {
                "description": "Descrição, opção 2",
                "id": "2",
                "title": "Opção 2"
              }
            ],
            "title": "Opções disponíveis"
          }
        ]
      },
      "text": "Selecione a opção que melhor encaixa para você!"
    },
    "id": "3EB0D33E50E19D78A5A789",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2025-03-08T17:54:46.000Z",
    "type": "text"
  },
  "id": "f7wjjrkpd1d1nyjl3n5kl",
  "type": "message.received"
}  

Exemplo: Mensagem resposta à lista de opções

Assim como o exemplo acima, o tipo de mensagem chegará como text porém a propriedade list_reply (data.list_reply) mostrará qual opção o usuário selecionou.

{
  "created_at": "2025-03-08T18:15:09.450Z",
  "data": {
    "content": {
      "list_reply": {
        "title": "Opção 2",
        "description": "Descrição, opção 2",
        "id": "2"
      },
      "text": "Descrição, opção 2",
      "quoted": {
        "content": {
          "list_options": {
            "button_label": "Abrir lista de opções",
            "sections": [
              {
                "description": null,
                "options": [
                  {
                    "description": "Descrição, opção 1",
                    "id": "1",
                    "title": "Opção 1"
                  },
                  {
                    "description": "Descrição, opção 2",
                    "id": "2",
                    "title": "Opção 2"
                  }
                ],
                "title": "Opções disponíveis"
              }
            ]
          },
          "text": "Selecione a opção que melhor encaixa para você!"
        }
        "id": "3EB0D33E50E19D78A5A789",
        "recipient": {
          "name": "Recipient Name",
          "id": "551112341234",
          "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
          "type": "chat"
        },
        "sender": {
          "name": "Sender Name",
          "id": "551112341234",
          "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
        },
        "sent_at": "2025-03-08T17:54:46.000Z",
        "type": "text"
      }
    },
    "id": "3EB081D5F40D11F1C39815",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2025-03-08T18:15:08.000Z",
    "type": "text"
  },
  "id": "9sj082811g9xm1bja68fp",
  "type": "message.received"
}

`message.sent`

Uma mensagem foi enviada da instância mensagem pode ter sido enviada através do Whatsapp ou através da API da Zapster. Você consegue identificar facilmente a origem do envio olhando para a propriedade data.origin que tem 2 valores possíveis (zapsterapi ou whatsapp), que identificarão a origem do envio da mensagem. Para detalhamento completo de como é o formato do objeto mensagem verifique na página Estrutura dos eventos > Mensagem

Exemplo: Mensagem de texto

{
  "created_at": "2024-09-14T13:55:46.420Z",
  "data": {
    "content": {
      "text": "Oi"
    },
    "id": "3AAB4DA4297176B74E38",
    "recipient": {
      "name": "Recipient Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "551112341234",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
    },
    "sent_at": "2024-09-14T13:55:46.000Z",
    "origin": "zapsterapi",
    "type": "text"
  },
  "id": "y66lhiw5la6z3r8f1urm0",
  "type": "message.sent"
}

`message.delivered`

Indica que a mensagem foi entregue ao destinatário.

Exemplo

{
  "created_at": "2025-09-03T13:38:17.798Z",
  "data": {
    "content": {
      "text": "ok"
    },
    "id": "3ADC5C4A6F9DABCDEF25",
    "recipient": {
      "name": "Recipient Name",
      "id": "5511999999999",
      "profile_picture": "https://zapsterapi...",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "5511999990000",
      "profile_picture": "https://zapsterapi..."
    },
    "sent_at": "2025-09-03T13:38:17.000Z",
    "type": "text"
  },
  "id": "YHSC28q7sD32zm0ier3BQ",
  "type": "message.delivered"
}

`message.read`

Indica que a mensagem foi lida pelo destinatário.

Nas configurações de privacidade da instância, se a confirmação de leitura estiver desativada, você não poderá ver nem exibir confirmações de leitura. Então o evento de webhook não irá disparar.

Ative ou desative a confirmação de leitura

Exemplo

{
  "created_at": "2025-09-03T14:36:46.585Z",
  "data": {
    "content": {
      "text": "Message readed"
    },
    "id": "3920A9F9FAFEC78CBE1C26E6ABCDEF25",
    "recipient": {
      "id": "5511999999999",
      "profile_picture": "https://zapsterapi.s3...",
      "name": "Recipient Name",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "5511999999999",
      "profile_picture": "https://zapsterapi.s3..."
    },
    "sent_at": "2025-09-03T14:07:17.000Z",
    "type": "text"
  },
  "id": "Cj41hzsvNUEr6isfHBrHJ",
  "type": "message.read"
}

`message.deleted`

Indica que uma mensagem foi apagada (para mim ou para todos) na conversa.

Exemplo

{
  "created_at": "2025-09-03T14:15:05.588Z",
  "data": {
    "content": {
      "text": "teste"
    },
    "id": "3A4B7D720682ABCDEF25",
    "recipient": {
      "approval_mode": "auto_approve",
      "description": null,
      "id": "120363402123456789",
      "invite_code": null,
      "invite_mode": "all_members",
      "is_announcement": false,
      "is_community": false,
      "is_restricted": false,
      "name": "Group Name",
      "owner": {
        "name": "Owner Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3..."
      },
      "profile_picture": null,
      "total_participants": 2,
      "type": "group"
    },
    "sender": {
      "name": "Sender Name",
      "id": "5511999990000",
      "profile_picture": "https://zapsterapi.s3..."
    },
    "sent_at": "2025-09-03T14:10:04.000Z",
    "type": "text"
  },
  "id": "ToMoKaeAtAYhHLhhI6GNY",
  "type": "message.deleted"
}

`message.reaction`

Indica que uma reação (emoji) foi aplicada a uma mensagem.

Exemplo

{
  "created_at": "2025-09-02T20:57:57.182Z",
  "data": {
    "id": "3EB0220A8B6B28ABCDEF25",
    "reacted_at": "2025-09-02T23:35:05.000Z",
    "reacted_by": {
      "name": "Recipient Name",
      "id": "5511999999999",
      "profile_picture": "https://zapsterapi.s3..."
    },
    "reacted_message": {
      "content": {
        "text": "teste reaction"
      },
      "id": "3AC0C55193850CB8F36C",
      "recipient": {
        "name": "Recipient Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3...",
        "type": "chat"
      },
      "sender": {
        "name": "Sender Name",
        "id": "5511999990000",
        "profile_picture": "https://zapsterapi.s3..."
      },
      "sent_at": "2025-09-02T23:34:58.000Z",
      "type": "text"
    },
    "reaction": "😮"
  },
  "id": "l1j0pt4wofz904u0456sp",
  "type": "message.reaction"
}

Reações a mensagens com mais de 72 horas o objeto reacted_message não será enviado com todas informações, mas sim apenas com o ID da mensagem que foi reagida.

Exemplo

{
  "created_at": "2025-09-02T17:28:39.272Z",
  "data": {
    "id": "3EB0353F4E0589D1AFC7BF",
    "reacted_at": "2025-09-02T17:28:38.000Z",
    "reacted_by": {
      "name": "Reacted by Name",
      "id": "551112341234",
      "profile_picture": "..."
    },
    "reacted_message": {
      "id": "3EB0308CD725A43924946B"
    },
    "reaction": "😂"
  },
  "id": "nmy2s3rq9yz5rysq692bw",
  "type": "message.reaction"
}

`message.pinned`

Indica que uma mensagem foi fixada na conversa/grupo.

Exemplo

{
  "created_at": "2025-09-02T20:57:57.182Z",
  "data": {
    "author": {
      "name": "Author Name",
      "id": "5511999999999",
      "profile_picture": "https://zapsterapi.s3..."
    },
    "message": {
      "duration": 604800,
      "content": {
        "text": "Dia 19 meeting de boas vindas"
      },
      "id": "3A73212D3B60ABCDEF25",
      "recipient": {
        "approval_mode": "auto_approve",
        "description": null,
        "id": "120363420123456789",
        "invite_code": null,
        "invite_mode": "all_members",
        "is_announcement": false,
        "is_community": false,
        "is_restricted": false,
        "name": "Group Name",
        "owner": {
          "name": "Owner Name",
          "id": "5511999999999",
          "profile_picture": "https://zapsterapi.s3..."
        },
        "profile_picture": null,
        "total_participants": 4,
        "type": "group"
      },
      "sender": {
        "name": "Sender Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3..."
      },
      "sent_at": "2025-09-02T22:17:50.000Z",
      "type": "text"
    }
  },
  "id": "l1j0pt4wofz904u0456sp",
  "type": "message.pinned"
}

`message.unpinned`

Indica que uma mensagem foi desafixada.

Exemplo

{
  "created_at": "2025-09-02T20:57:57.182Z",
  "data": {
    "author": {
      "name": "Author Name",
      "id": "5511999999999",
      "profile_picture": "https://zapsterapi.s3..."
    },
    "message": {
      "content": {
        "text": "Meeting de boas vindas"
      },
      "id": "3A73212D3B60ABCDEF25",
      "recipient": {
        "approval_mode": "auto_approve",
        "description": null,
        "id": "120363420123456789",
        "invite_code": null,
        "invite_mode": "all_members",
        "is_announcement": false,
        "is_community": false,
        "is_restricted": false,
        "name": "Group name",
        "owner": {
          "name": "Owner Name",
          "id": "5511999999999",
          "profile_picture": "https://zapsterapi.s3..."
        },
        "profile_picture": null,
        "total_participants": 4,
        "type": "group"
      },
      "sender": {
        "name": "Sender Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3..."
      },
      "sent_at": "2025-09-02T22:17:50.000Z",
      "type": "text"
    }
  },
  "id": "l1j0pt4wofz904u0456sp",
  "type": "message.unpinned"
}

`instance.mentioned`

Indica que sua instância foi mencionada (”@…”) em uma conversa/grupo.

Exemplo

{
  "created_at": "2025-09-02T20:57:57.182Z",
  "data": {
    "author": {
      "name": "Author Name",
      "id": "5511999999999",
      "profile_picture": "https://zapsterapi.s3..."
    },
    "mentioned_at": "2025-09-02T22:17:43.000Z",
    "message": {
      "content": {
        "mentions": [
          {
            "name": "Mentioned Name",
            "id": "5511999999999",
            "profile_picture": "https://zapsterapi.s3..."
          }
        ],
        "text": "@5511999999999"
      },
      "id": "90C1979C3AA24B5FD8868523ABCDEF25",
      "sent_at": "2025-09-02T22:17:43.000Z",
      "type": "text"
    },
    "recipient": {
      "approval_mode": "auto_approve",
      "description": null,
      "id": "120363420123456789",
      "invite_code": null,
      "invite_mode": "all_members",
      "is_announcement": false,
      "is_community": false,
      "is_restricted": false,
      "name": "Group Name",
      "owner": {
        "name": "Owner Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3..."
      },
      "profile_picture": null,
      "total_participants": 4,
      "type": "group"
    }
  },
  "id": "l1j0pt4wofz904u0456sp",
  "type": "instance.mentioned"
}

`instance.qrcode`

Notifica quando um novo QR Code é gerado/atualizado para a instância.

Exemplo

{
  "created_at": "2025-09-02T20:57:57.182Z",
  "data": {
    "qrcode": "2@6t2v/gh1D+Ru+RnuEJf9hwjOEyar29s/1x6aWvfLvN38G/g..."
  },
  "id": "7jatr6a3hnn1qlxoz2ccc",
  "type": "instance.qrcode"
}

`group.created`

Indica que um novo grupo foi criado.

Exemplo

{
  "id": "2711aqyqcy9ooavsvnu0e",
  "data": {
    "id": "120363420123456789",
    "name": "Group Name",
    "owner": {
      "id": "5511999999999",
      "name": "Owner Name",
      "profile_picture": "https://zapsterapi.s3..."
    },
    "description": null,
    "invite_code": "KlMCWzU3TakKghDpKFgVbr",
    "invite_mode": "all_members",
    "is_community": false,
    "approval_mode": "requires_approval",
    "is_restricted": false,
    "is_announcement": false,
    "profile_picture": null,
    "total_participants": 4
  },
  "type": "group.created",
  "created_at": "2025-09-02T21:52:34.409Z"
}

`group.updated`

Indica que os dados do grupo foram atualizados (nome, foto, descrição, etc.).

Exemplo

{
  "created_at": "2025-09-02T21:37:49.741Z",
  "data": {
    "approval_mode": "requires_approval",
    "description": "Description of group",
    "id": "120363020089898070",
    "invite_code": "KxBnzvpAzFZsMnHJmj9EK5",
    "invite_mode": "admins_only",
    "is_announcement": false,
    "is_community": false,
    "is_restricted": false,
    "name": "Group Name",
    "owner": {
      "name": "Owner Name",
      "id": "5511999999999",
      "profile_picture": "https://zapsterapi.s3..."
    },
    "profile_picture": "https://zapsterapi.s3...",
    "total_participants": 3
  },
  "id": "l1j0pt4wofz904u0456sp",
  "type": "group.updated"
}

`group.participants_added`

Indica que um ou mais participantes foram adicionados ao grupo.

Exemplo

{
  "created_at": "2025-09-02T20:57:57.182Z",
  "data": {
    "author": {
      "name": "Author Name",
      "id": "5511999999999",
      "profile_picture": "https://zapsterapi.s3..."
    },
    "group": {
      "approval_mode": "requires_approval",
      "description": null,
      "id": "120363020123456789",
      "invite_code": "KxBnzvpAzFZsMnHJmj9EK5",
      "invite_mode": "admins_only",
      "is_announcement": false,
      "is_community": false,
      "is_restricted": false,
      "name": "Group Name",
      "owner": {
        "name": "Owner Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3..."
      },
      "profile_picture": "https://zapsterapi.s3...",
      "total_participants": 3
    },
    "participants": [
      {
        "name": "Participants Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3..."
      }
    ]
  },
  "id": "l1j0pt4wofz904u0456sp",
  "type": "group.participants_added"
}

`group.participants_removed`

Indica que participantes foram removidos do grupo.

Exemplo

{
  "created_at": "2025-09-02T20:57:57.182Z",
  "data": {
    "author": {
      "name": "Author Name",
      "id": "5511999999999",
      "profile_picture": "https://zapsterapi.s3..."
    },
    "group": {
      "approval_mode": "requires_approval",
      "description": null,
      "id": "120363020123456789",
      "invite_code": "KxBnzvpAzFZsMnHJmj9EK5",
      "invite_mode": "admins_only",
      "is_announcement": false,
      "is_community": false,
      "is_restricted": false,
      "name": "Group Name",
      "owner": {
        "name": "Owner Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3..."
      },
      "profile_picture": "https://zapsterapi.s3...",
      "total_participants": 3
    },
    "participants": [
      {
        "name": "Participant Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3..."
      }
    ]
  },
  "id": "l1j0pt4wofz904u0456sp",
  "type": "group.participants_removed"
}

`group.participants_promoted`

Indica que participantes foram promovidos a administradores.

Exemplo

{
  "created_at": "2025-09-02T20:57:57.182Z",
  "data": {
    "author": {
      "name": "Author Name",
      "id": "5511999999999",
      "profile_picture": "https://zapsterapi.s3..."
    },
    "group": {
      "approval_mode": "requires_approval",
      "description": null,
      "id": "120363020123456789",
      "invite_code": "KxBnzvpAzFZsMnHJmj9EK5",
      "invite_mode": "admins_only",
      "is_announcement": false,
      "is_community": false,
      "is_restricted": false,
      "name": "Group Name",
      "owner": {
        "name": "Owner Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3..."
      },
      "profile_picture": "https://zapsterapi.s3...",
      "total_participants": 3
    },
    "participants": [
      {
        "name": "Participant Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3..."
      }
    ]
  },
  "id": "l1j0pt4wofz904u0456sp",
  "type": "group.participants_promoted"
}

`group.participants_demoted`

Indica que participantes foram rebaixados de administradores para membros.

Exemplo

{
  "created_at": "2025-09-02T20:57:57.182Z",
  "data": {
    "author": {
      "name": "Author Name",
      "id": "5511999999999",
      "profile_picture": "https://zapsterapi.s3..."
    },
    "group": {
      "approval_mode": "requires_approval",
      "description": null,
      "id": "120363020123456789",
      "invite_code": "KxBnzvpAzFZsMnHJmj9EK5",
      "invite_mode": "admins_only",
      "is_announcement": false,
      "is_community": false,
      "is_restricted": false,
      "name": "Group Name",
      "owner": {
        "name": "Owner Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3..."
      },
      "profile_picture": "https://zapsterapi.s3...",
      "total_participants": 3
    },
    "participants": [
      {
        "name": "Participant Name",
        "id": "5511999999999",
        "profile_picture": "https://zapsterapi.s3..."
      }
    ]
  },
  "id": "l1j0pt4wofz904u0456sp",
  "type": "group.participants_demoted"
}    

Introdução

Conceitos

Webhooks

Integrações

`instance.connected`

`instance.disconnected`

`message.received`

`message.sent`

`message.delivered`

`message.read`

`message.deleted`

`message.reaction`

`message.pinned`

`message.unpinned`

`instance.mentioned`

`instance.qrcode`

`group.created`

`group.updated`

`group.participants_added`

`group.participants_removed`

`group.participants_promoted`

`group.participants_demoted`

Introdução

Conceitos

Webhooks

Integrações

​instance.connected

​instance.disconnected

​message.received

​message.sent

​message.delivered

​message.read

​message.deleted

​message.reaction

​message.pinned

​message.unpinned

​instance.mentioned

​instance.qrcode

​group.created

​group.updated

​group.participants_added

​group.participants_removed

​group.participants_promoted

​group.participants_demoted

`instance.connected`

`instance.disconnected`

`message.received`

`message.sent`

`message.delivered`

`message.read`

`message.deleted`

`message.reaction`

`message.pinned`

`message.unpinned`

`instance.mentioned`

`instance.qrcode`

`group.created`

`group.updated`

`group.participants_added`

`group.participants_removed`

`group.participants_promoted`

`group.participants_demoted`