O Calendly suporta webhooks por meio de nossa API aberta, permitindo que você receba atualizações em tempo real quando eventos importantes ocorrem em sua conta. Use a API v2 para enviar dados de eventos para um URL especificado quando alguém agendar ou cancelar uma reunião ou enviar um formulário de encaminhamento.
Por exemplo, você pode:
- Acione ações quando uma nova reunião é agendada
- Atualizar sistemas quando um evento é cancelado
- Capturar dados quando alguém enviar um formulário de encaminhamento (mesmo que nenhum evento seja agendado)
Antes de começar
- Você precisará de acesso a um token pessoal de acesso ou um aplicativo OAuth para autenticação.
- Certifique-se de que seu endpoint esteja pronto para receber e processar dados de webhooks.
- Consulte os Casos de uso da API do Calendly para obter mais ideias e exemplos.
Tipos de eventos de webhook
O Calendly suporta as seguintes assinaturas de webhooks:
- Eventos criados pelo convidado — quando um novo evento é agendado
- Eventos cancelados do convidado — quando um evento existente é cancelado
- Envios de formulários de encaminhamento — quando alguém envia um formulário de encaminhamento (com ou sem agendamento)
Criar um webhook
Siga as etapas mostradas em nosso Portal de Desenvolvedores.
Depois de criar sua assinatura de webhook, o Calendly envia dados de eventos para o endpoint especificado por você. Veja exemplos de dados em nossa Documentação de payload do webhook.
Excluir um webhook
Para remover um webhook, visite nosso guia Excluir Assinatura de Webhook.
Práticas recomendadas
Para desenvolvedores:
- Use URLs HTTPS seguras para seus endpoints de webhook.
- Valide assinaturas de webhooks recebidas para obter segurança adicional.
- Lide com repetições e evite processamento duplicado verificando IDs de eventos.
Para administradores:
- Monitore quem criou assinaturas de webhooks.
- Se um usuário que criou webhooks for removido da sua organização, seus webhooks permanecem ativos até serem excluídos manualmente.