{"id":96800,"date":"2019-06-27T06:14:50","date_gmt":"2019-06-27T06:14:50","guid":{"rendered":"https:\/\/mailrelay.com\/blog\/2026\/09\/29\/mailrelay-v3-webhooks-para-conectar-com-sistemas-externos\/"},"modified":"2026-09-29T19:11:52","modified_gmt":"2026-09-29T19:11:52","slug":"mailrelay-v3-webhooks-para-conectar-com-sistemas-externos","status":"publish","type":"post","link":"https:\/\/mailrelay.com\/pt\/blog\/2019\/06\/27\/mailrelay-v3-webhooks-para-conectar-com-sistemas-externos\/","title":{"rendered":"Mailrelay v3 Webhooks para conectar com sistemas externos"},"content":{"rendered":"

Recentemente adicionamos um novo recurso \u00e0 nova vers\u00e3o do Mailrelay, os webhooks.<\/strong><\/p>\n

Os webhooks complementam o envio via API ou servi\u00e7os SMTP<\/a> para integrar o Mailrelay aos seus sistemas externos.<\/p>\n

Os webhooks permitem fazer conex\u00f5es em tempo real com sistemas externos,<\/strong> e atualmente \u00e9 poss\u00edvel definir:<\/p>\n

    \n
  1. Quando um assinante \u00e9 adicionado a um grupo<\/li>\n
  2. Quando \u00e9 removido do grupo<\/li>\n
  3. Ou quando cancela a inscri\u00e7\u00e3o<\/li>\n<\/ol>\n

    Para que servem esses webhooks?<\/strong><\/p>\n

    Vou te dar um exemplo bem simples: imagine que a sua empresa gerencia todos os contatos e clientes em um CRM pr\u00f3prio, onde est\u00e3o todos os dados deles, as compras anteriores, etc. E, para enviar as campanhas de email a eles, exporta esses contatos e os importa no Mailrelay, de onde faz os envios.<\/p>\n

    O problema, at\u00e9 agora, era que, embora no Mailrelay os contatos possam cancelar a inscri\u00e7\u00e3o pelos links da newsletter, para cancelar a inscri\u00e7\u00e3o deles no CRM (ou em outro sistema externo)<\/em> era preciso usar a API ou fazer isso manualmente.<\/p>\n

    Com a nova op\u00e7\u00e3o de webhooks fica mais f\u00e1cil<\/strong> enviar uma requisi\u00e7\u00e3o e trat\u00e1-la programaticamente do lado do CRM.<\/p>\n

    Neste post vamos ver como definir e testar o funcionamento dos webhooks.<\/p>\n<\/p>\n

    \u00b7 Definindo um webhook para os cancelamentos de inscri\u00e7\u00e3o<\/h2>\n

    Os webhooks s\u00e3o definidos na se\u00e7\u00e3o de Automa\u00e7\u00f5es:<\/strong><\/p>\n

    \"webhooks<\/p>\n

    Uma vez nesta se\u00e7\u00e3o, vamos criar uma nova automa\u00e7\u00e3o:<\/p>\n

    \"nova<\/p>\n

    A automa\u00e7\u00e3o que vamos criar \u00e9 do tipo \u201cpersonalizado\u201d<\/strong> (a outra op\u00e7\u00e3o \u00e9 a de anivers\u00e1rio, mas essa n\u00e3o nos interessa agora):<\/p>\n

    \"criar<\/p>\n

    A partir daqui, teremos que fazer a defini\u00e7\u00e3o b\u00e1sica da automa\u00e7\u00e3o.<\/p>\n

    Vamos comentar os par\u00e2metros mais importantes depois da imagem a seguir:<\/p>\n

    \"defini\u00e7\u00e3o<\/p>\n

    Temos estas op\u00e7\u00f5es:<\/p>\n

      \n
    1. Nome:<\/strong> este \u00e9 apenas o nome interno do trigger, voc\u00ea pode cham\u00e1-lo como preferir<\/li>\n
    2. Todos os assinantes:<\/strong> poder\u00edamos definir um grupo espec\u00edfico, mas para este exemplo seleciono todos<\/li>\n<\/ol>\n

      Depois de definir esses pontos, teremos que \u201cAdicionar trigger\u201d<\/strong>, para definir a a\u00e7\u00e3o que vai desencadear o evento.<\/p>\n

      Vamos escolher a op\u00e7\u00e3o \u201cAtividade do Assinante\u201d:<\/strong><\/p>\n

      \"webhook<\/p>\n

      Entre todas as op\u00e7\u00f5es de atividade do assinante, temos:<\/p>\n

      \"evento<\/p>\n

      Vamos usar o evento de cancelamento da inscri\u00e7\u00e3o<\/strong>, que \u00e9 o que nos interessa neste momento, mas seria poss\u00edvel definir eventos para quando um assinante \u00e9 adicionado a um grupo ou \u00e9 removido de um grupo (sem cancelar a inscri\u00e7\u00e3o):<\/p>\n

      \"webhook<\/p>\n

      Ao trigger vamos dar o nome que quisermos e, algo importante:<\/strong><\/p>\n

        \n
      1. Webhook url<\/strong>: ou seja, a URL para a qual a requisi\u00e7\u00e3o ser\u00e1 enviada quando o cancelamento de inscri\u00e7\u00e3o de um contato for processado.<\/li>\n
      2. A requisi\u00e7\u00e3o normalmente \u00e9 enviada no array GET, n\u00e3o no POST<\/li>\n<\/ol>\n

        A URL de destino do webhook \u00e9 uma URL do nosso site onde podemos receber as informa\u00e7\u00f5es enviadas pelo Mailrelay, com os dados do contato que cancelou a inscri\u00e7\u00e3o, e tratar essas informa\u00e7\u00f5es da forma que precisarmos.<\/p>\n

        Feito isso, resta Validar e aplicar:<\/strong><\/p>\n

        \"validar<\/p>\n

        E, por \u00faltimo, para criar toda a automa\u00e7\u00e3o, clique no bot\u00e3o \u201ccriar automa\u00e7\u00e3o\u201d<\/strong>:<\/p>\n

        \"criar<\/p>\n

        Dessa forma, tudo estar\u00e1 pronto e s\u00f3 falta que, do lado do CRM ou software, sejam tratadas as chamadas que ser\u00e3o disparadas quando ocorrer algum cancelamento de inscri\u00e7\u00e3o.<\/p>\n

        \"Webhooks<\/a><\/p>\n

        \u00b7 Testando o webhook com ferramentas de teste<\/h2>\n

        Talvez voc\u00ea queira testar o webhook sem ter ainda a programa\u00e7\u00e3o do lado do seu software; para isso, voc\u00ea pode usar um servi\u00e7o como o RequestBin:<\/p>\n

        \"requestbin\"<\/p>\n

        Nesta tela basta clicar no bot\u00e3o \u201cCreate a RequestBin\u201d,<\/strong> e recomendo tamb\u00e9m que voc\u00ea o crie de forma privada.<\/p>\n

        Feito isso, voc\u00ea ver\u00e1 uma tela parecida com a seguinte:<\/p>\n

        \"URL<\/p>\n

        Voc\u00ea pode copiar essa URL e col\u00e1-la quando estiver criando o webhook:<\/p>\n

        \"criando<\/p>\n

        Basta colocar a URL no campo do formul\u00e1rio e depois podemos disparar um teste pelo bot\u00e3o \u201cWebhook de teste\u201d<\/strong>:<\/p>\n

        \"envio<\/p>\n

        Se aceitarmos a mensagem, o webhook ser\u00e1 enviado e poderemos ver a requisi\u00e7\u00e3o no RequestBin<\/strong>:<\/p>\n

        \"requestbin\"<\/p>\n

        \u00c9 uma requisi\u00e7\u00e3o de exemplo, mas mant\u00e9m a mesma estrutura de uma requisi\u00e7\u00e3o real:<\/p>\n

        {\u00abunsubscribe_event\u00bb:{\u00absource\u00bb:\u00bbweb\u00bb,\u00bbip\u00bb:\u00bb192.168.1.1\u2033,\u00bbemail\u00bb:\u00bbuser@example.com\u00bb,\u00bbreason\u00bb:null,
        \u00abdescription\u00bb:null,\u00bbcreated_at\u00bb:\u00bb2019-06-14T10:48:41.510+02:00\u2033},
        \u00abtime\u00bb:\u00bb2019-06-14T10:48:41.511+02:00\u2033,\u00bbautomation_trigger_id\u00bb:0,\u00bbsubscriber\u00bb:{\u00abid\u00bb:null,\u00bbemail\u00bb:\u00bbuser@example.com\u00bb,
        \u00abname\u00bb:null,\u00bbscore\u00bb:null,\u00bbstatus\u00bb:\u00bbinactive\u00bb,
        \u00absubscribed_at\u00bb:null,\u00bbsubscribed_with_acceptance\u00bb:false,\u00bbsubscribe_ip\u00bb:null,
        \u00abunsubscribed\u00bb:false,\u00bbunsubscribed_at\u00bb:null,\u00bbunsubscribe_ip\u00bb:null,
        \u00abunsubscribe_sent_email_id\u00bb:null,\u00bbaddress\u00bb:null,\u00bbcity\u00bb:null,\u00bbstate\u00bb:null,
        \u00abcountry\u00bb:null,\u00bbbirthday\u00bb:null,\u00bbwebsite\u00bb:null,\u00bbbounced\u00bb:false,\u00bbreported_spam\u00bb:false,
        \u00ablocal_ban\u00bb:false,\u00bbglobal_ban\u00bb:false,\u00bbcreated_at\u00bb:\u00bb2019-06-14T10:48:41.507+02:00\u2033,\u00bbupdated_at\u00bb:\u00bb2019-06-14T10:48:41.507+02:00\u2033,
        \u00abcustom_fields\u00bb:{}}}<\/p>\n

        Assim voc\u00ea pode conhecer essa estrutura para trat\u00e1-la no seu sistema.<\/p>\n

        Voc\u00ea tamb\u00e9m pode fazer requisi\u00e7\u00f5es reais<\/strong> se salvar a automa\u00e7\u00e3o e gerar um cancelamento de inscri\u00e7\u00e3o real.<\/p>\n

        Essas voc\u00ea ver\u00e1 no RequestBin, mas j\u00e1 com as informa\u00e7\u00f5es reais do contato.<\/p>\n

        \"Automa\u00e7\u00f5es<\/p>\n

        Posts relacionados:<\/p>\n