Webhook de E-mail

Quer que o seu sistema saiba na hora que um e-mail chegou ou foi enviado pelas contas de e-mail da empresa? O Webhook de E-mail avisa o seu sistema a cada e-mail recebido e a cada e-mail enviado.

O Webhook de E-mail cobre só os e-mails. As conversas com os clientes são avisadas pelos webhooks da Conexão e do Setor.

Onde ligar o Webhook de E-mail

Webhook de e-mail: o endereço que recebe os avisos dos e-mails de todas as contas de e-mail da empresa. Em branco, nada é enviado. O botão Salvar, ao lado do campo, grava o endereço, e a tela avisa "Webhook de e-mail salvo."

O endereço precisa começar com http:// ou https://, sem espaços, e não pode apontar para a rede interna.

Os eventos do Webhook de E-mail

Tudo chega no mesmo endereço. Os eventos enviados são estes:

Nas palavras da tela, o Webhook de E-mail "Só avisa o e-mail recebido com até 48 horas (a caixa antiga não dispara a automação)."

O que chega em cada aviso

Cada aviso chega em JSON, com o mesmo formato nos dois eventos:

acao: o evento, como email-recebido.

companyId, enviadoEm, com a hora do envio do aviso, e backendURL, o endereço da plataforma.

email: o e-mail. Traz o id, a conta (accountId e accountEmail), a pasta (folder), o tipo (recebido ou enviado), from, to e cc, o assunto (subject), o começo do texto (snippet), o texto inteiro (text), hasAttachments, que diz se tem anexo, isSeen, que diz se foi lido, a data (date) e os identificadores da mensagem (messageId, inReplyTo e threadId).

Exemplo de email-recebido:

{
  "acao": "email-recebido",
  "companyId": 2,
  "email": {
    "id": 981,
    "accountId": 2,
    "accountEmail": "contato@lojaexemplo.com.br",
    "folder": "INBOX",
    "tipo": "recebido",
    "messageId": "<a1b2c3@cliente.com>",
    "inReplyTo": null,
    "threadId": "<a1b2c3@cliente.com>",
    "from": { "address": "maria@cliente.com", "name": "Maria Souza" },
    "to": [{ "address": "contato@lojaexemplo.com.br", "name": null }],
    "cc": [],
    "subject": "Orçamento do pedido 120",
    "snippet": "Bom dia! Podem me mandar o orçamento do pedido 120?",
    "text": "Bom dia! Podem me mandar o orçamento do pedido 120?",
    "hasAttachments": false,
    "isSeen": false,
    "date": "2026-11-05T11:42:10.000Z"
  },
  "enviadoEm": "2026-11-05T11:42:17.844Z",
  "backendURL": "https://api.exemplo.com.br"
}

Como saber que o aviso veio daqui

Nas palavras da tela, o aviso do Webhook de E-mail vai assinado com o Token da Empresa, no cabeçalho X-Assinatura-Email.