Atenção: esse é um artigo de caráter técnico.

Sim, a API do Agendor possui Webhooks para possibilitar a integração do Agendor com o seu sistema em tempo real.

Dentre as várias formas de integrar o seu sistema com o Agendor, a mais comum é sincronizar a base de clientes do seu sistema (do seu ERP, por exemplo) com o Agendor. Digamos que você deseja que toda vez que um negócio for ganho ou avance para uma etapa no Agendor, as informações da empresa como CNPJ, endereço e razão social sejam enviadas para o seu ERP. Isso é possível usando os Webhooks!

Esse artigo foi feito para programadores saberem como utilizar os Webhooks da nossa API.

Lembrando que, para realizar a integração via API, você vai precisar do seu token de autenticação (que pode ser encontrado em Menu > Integrações).

Como utilizar os Webhooks

São gatilhos que permitem que o seu sistema seja notificado quando um determinado evento acontecer na sua conta do Agendor. Os Webhooks permitem que o seu sistema seja avisado em tempo real quando uma mudança ocorrer no Agendor.

Por exemplo, quando um negócio for ganho, criar um registro de venda no ERP. Ou quando uma empresa for criada/alterada, criar/alterar também uma empresa com o mesmo nome ou CNPJ no ERP.

Temos essa biblioteca do Postman com exemplos de uso dos Webhooks.

Eventos disponíveis

→ Quando uma atividade/tarefa/comentário for criada: on_activity_created

→ Quando uma empresa for criada: on_organization_created

→ Quando uma empresa for alterada: on_organization_updated

→ Quando um negócio for criado: on_deal_created

→ Quando um negócio for perdido: on_deal_lost

→ Quando um negócio mudar de etapa: on_deal_stage_updated

→ Quando um negócio for alterado: on_deal_updated

→ Quando um negócio for ganho: on_deal_won

→ Quando uma pessoa for criada: on_person_created

→ Quando uma pessoa for alterada: on_person_updated

Como criar um Webhook?

Basta enviar uma requisição HTTP com o método POST para a URL https://api.agendor.com.br/integrations/subscriptions com os parâmetros:

target_url: A URL da sua API que receberá requisições quando um determinado evento acontecer
event: O evento que irá disparar as requisições para a sua API

Exemplo

Criar um Webhook para quando um negócio for movido de etapa:

curl -X POST 'https://api.agendor.com.br/integrations/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token xxxxx-xxxxx-xxxxx-xxxx-xxxxx' \
-d '{
  "target_url": "https://urldasuaapi.com",
  "event": "on_deal_stage_updated"
}'

Pronto, agora toda vez que qualquer negocio for movido de etapa, a sua API será notificada.

Como listar os Webhooks existentes?

Após criar os Webhooks, você pode listá-los fazendo uma requisição HTTP com o método GET para a URL https://api.agendor.com.br/integrations/subscriptions.

Exemplo

curl -X GET 'https://api.agendor.com.br/integrations/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token xxxxx-xxxxx-xxxxx-xxxx-xxxxx'

Como excluir um Webhook?

Basta fazer uma requisição HTTP com o método DELETE para a URL https://api.agendor.com.br/integrations/subscriptions/<id>.

Exemplo

Supondo que você deseja excluir o Webhook de ID 1234:

curl -X DELETE 'https://api.agendor.com.br/integrations/subscriptions/1234' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token xxxxx-xxxxx-xxxxx-xxxx-xxxxx'

Links úteis

Documentação da API: https://api.agendor.com.br/
Biblioteca do Postman com exemplo de uso das rotas da API
Biblioteca do Postman com exemplo de uso de Webhooks

Dúvidas com relação a esse conteúdo? Procure nossa equipe de Suporte nos canais disponíveis!