Como implementar Webhooks na HubSpot e como eles diferem de uma API?

[PamCotton]

A HubSpot fornece várias APIs diferentes e, além disso, também oferecemos a opção de aproveitar os webhooks. Este post discute isso com mais detalhes e também elabora diferentes métodos de implementação.

A principal diferença é que, com uma solicitação de API, você está "solicitando" proativamente informações do sistema. Isso pode não ser necessário, pois os dados podem não ter sido alterados desde sua última solicitação e podem não ser o uso mais eficiente do seu limite de chamadas.

Com um Webhook, por outro lado, você é notificado pelo sistema assim que os dados são alterados sem precisar fazer solicitações de API continuamente. Na HubSpot, temos algumas maneiras de usar Webhooks.

Aqui está um diagrama destacando as diferenças gerais. Observe como, com uma API, fazemos solicitações continuamente, apesar dos dados nunca mudarem. Com um Webhook, simplesmente informamos ao servidor uma vez para nos informar se algo acontecer:

Webhook / API

 Como mencionado, você pode conseguir isso de várias maneiras na HubSpot.  Dividimos em mais detalhes abaixo. Cada um tem diferentes casos de uso, pontos fortes e fracos, por isso é importante qualificar com mais detalhes para garantir que você saiba o que posicionar/recomendar.

 

1. API de Webhooks: Gratuita e atualizada
   Isso envolve configurar um aplicativo e assinar vários eventos que ocorrem em qualquer portal em que seu aplicativo esteja instalado. Os eventos incluem a criação, exclusões e atualizações de propriedades de Contatos, Empresas e Negócios. A desvantagem disso é que ele não suporta objetos Ticket. A principal vantagem é que é leve e fácil de configurar. Um exemplo da carga útil pode ser encontrado aqui.
   Mais informações sobre nossa API de Webhooks podem ser encontradas em nossa documentação do desenvolvedor.
   
   
2. API de extensões de fluxo de trabalho: Marketing Pro/ Enterprise
   Isso só pode ser usado em fluxos de trabalho baseados em contato. A grande vantagem é que ele permite personalizar a carga útil que você deseja enviar para o URL do webhook, o que facilita o processamento da equipe de desenvolvimento. Também é muito mais amigável para a equipe de marketing que está criando fluxos de trabalho. A grande limitação é que ele só pode ser usado em fluxos de trabalho de contato (embora haja planos para estender isso para outros tipos de fluxo de trabalho no futuro). Um exemplo da carga útil pode ser encontrado aqui. Mais informações sobre a API de extensões de fluxo de trabalho podem ser encontradas em nossa documentação do desenvolvedor.
3.  Ação de fluxo de trabalho/bot Webhook: somente Operations Hub Professional
   Isso pode ser usado em todos os fluxos de trabalho, como Contato, Empresa, Negociação, Ticket e Cotação e/ou Bot. O HubSpot postará todos os dados do objeto no URL do webhook. Não há opção para personalizar a carga útil. A vantagem é que você pode aproveitá-lo em todos os fluxos de trabalho. Um exemplo da carga útil pode ser encontrado aqui. Mais informações sobre como usar a ação de webhook em um fluxo de trabalho podem ser encontradas em nossa documentação do desenvolvedor. Informações sobre o uso de fluxos de trabalho em bots podem ser encontradas aqui.

A analogia que gosto de usar é que imagine que você tem um amigo para quem você envia mensagens de texto continuamente perguntando quando eles estão dando uma festa (solicitação de API). Toda vez que eles respondem com a mesma resposta... Não. Então, em vez disso, você diz ao seu amigo uma vez para simplesmente notificá-lo quando ele estiver dando uma festa (Webhook) para que você não precise ficar enviando mensagens de texto.

Se você tiver alguma dúvida, deixe seu comentário abaixo.

versão em inglês *