Guias de integração

Webhooks

Receba notificações de eventos da agenda em um endpoint da sua aplicação.

Disponibilidade e configuração

O recurso depende da habilitação de webhooks no ambiente da API. A referência é gerada a partir do contrato publicado, refletindo os endpoints disponíveis naquela versão.

Cadastre uma URL HTTPS pública em POST /v2/webhooks/endpoints. O escritório é determinado pela chave de API. A criação pode retornar o estado PENDING_SYNC enquanto a configuração é sincronizada.

Quando o recurso estiver habilitado, seus campos estarão na referência da API.

Eventos declarados

Os eventos atualmente documentados no contrato Java são:

agenda.compromisso.criado
agenda.compromisso.concluido
agenda.compromisso.atualizado
agenda.comentario.criado

Use os valores enumerados na operação de assinaturas como referência ao implementar.

Atualização de assinaturas

PUT /v2/webhooks/endpoints/{id}/subscriptions substitui o conjunto de assinaturas do endpoint. Envie a lista completa desejada, incluindo os eventos que devem continuar ativos.

Atualização substitui o conjunto

Enviar apenas um novo evento não equivale a acrescentá-lo à lista existente. Revise o estado desejado antes da alteração.

Prepare o recebimento

Configure um serviço HTTPS que aceite as notificações esperadas. Registre o recebimento e processe tarefas demoradas de forma assíncrona. Prepare seu consumidor para reconhecer eventos já processados.

Valide o payload e os requisitos de entrega com a configuração efetivamente habilitada na sua API. O retorno técnico de uma operação de segredo não deve ser tratado como chave de assinatura sem confirmar seu formato com a equipe da Expedit.