Visão geral de Webhooks
Calendly oferece suporte a webhooks por meio de nossa API aberta, permitindo que você receba atualizações em tempo real quando eventos-chave ocorrerem na sua Conta. Use a API v2 para enviar dados do evento para uma URL especificada quando alguém agendar ou cancelar uma reunião, ou enviar um formulário de encaminhamento.
Por exemplo, você pode:
- Disparar ações quando uma nova reunião for agendada
- Atualizar sistemas quando um evento for cancelado
- Capturar dados quando alguém envia um formulário de encaminhamento (mesmo se nenhum evento for agendado)
Antes de começar
- Você precisará de acesso a um personal access token ou a um OAuth application para autenticação.
- Certifique-se de que seu endpoint esteja pronto para receber e processar dados de webhook.
- Veja os Casos de uso da API do Calendly para mais ideias e exemplos.
Tipos de eventos de webhook
Calendly suporta as seguintes assinaturas de webhook:
- Eventos de criação de convidado — quando um novo evento é agendado
- Eventos de cancelamento de convidado — quando um evento existente é cancelado
- Envios de formulário de encaminhamento — quando alguém envia um formulário de encaminhamento (com ou sem agendamento)
Criar um webhook
Siga os passos mostrados em nosso Portal do desenvolvedor.
Depois de criar uma assinatura de webhook, o Calendly envia os dados do evento para o endpoint que você especificar quando ocorrer nova atividade.
Para testar seu webhook, acione um novo evento (como um agendamento, cancelamento ou reagendamento). Webhooks não são acionados por eventos passados.
Veja dados de exemplo em nossa Documentação do payload do webhook. Excluir um webhook
Para remover um webhook, visite nosso Guia para excluir assinatura de webhook.
Melhores práticas
Para desenvolvedores:
- Use URLs HTTPS seguras para seus endpoints de webhook.
- Valide as assinaturas de webhook recebidas para maior segurança.
- Trate as tentativas de reenvio e evite processamentos duplicados verificando os IDs dos eventos.
Para administradores:
- Monitore quem criou assinaturas de webhook.
- Se um Usuário que criou webhooks for removido da sua organização, seus webhooks permanecerão ativos até serem excluídos manualmente.