Visão Geral
Webhooks permitem que sistemas externos recebam notificação imediata de eventos do PEP.ia (agendamentos, orçamentos e pagamentos) sem precisar consultar a API de tempos em tempos. Esta seção documenta as rotas de cadastro e operação dos endpoints que recebem esses eventos.
Criar Endpoint de Webhook
Cadastra um endpoint de webhook na conta. O secret de assinatura é devolvido uma única vez, nesta resposta.
Listar Endpoints de Webhook
Lista os endpoints de webhook da conta, do mais antigo para o mais novo, com as estatísticas de entrega das últimas 24 horas. Não inclui o segredo de assinatura.
Atualizar Endpoint de Webhook
Altera URL, descrição, eventos, filtros ou o estado (enabled) de um endpoint. Todos os campos são opcionais.
Remover Endpoint de Webhook
Remove o endpoint (exclusão lógica). Ele deixa de receber eventos.
Enviar Ping de Teste
Envia um evento técnico webhook.ping ao endpoint, para testar a URL e a verificação de assinatura sem depender de eventos reais. É sempre entregue, independentemente de eventtypes e filters. O envio é assíncrono: use o eventid devolvido em Listar Entregas (event_id=) para ver o resultado.
Rotacionar Segredo
Gera um novo segredo de assinatura e o devolve uma única vez. O segredo anterior continua assinando por 24 horas: até previoussecretexpires_at, cada entrega leva as duas assinaturas no header webhook-signature, o que permite trocar o segredo no consumidor sem perder eventos.
Listar Entregas
Histórico das entregas do endpoint nos últimos 2 dias, da mais recente para a mais antiga, com paginação por cursor. Não inclui o corpo da resposta do consumidor.
Reenviar Evento
Reenvia o evento às entregas que falharam (FAILED) de endpoints ativos, com o mesmo id e o ciclo completo de retentativas. Só é possível dentro da janela de retenção de 2 dias.
Estado Atual do Agendamento
Devolve o mesmo formato do data dos eventos appointment.*. Serve para reconciliar: como a entrega de webhooks não é ordenada, o consumidor pode reconsultar o estado atual do recurso e comparar o version.
Estado Atual do Orçamento
Devolve o mesmo formato do data dos eventos budget.*. Serve para reconciliar: como a entrega de webhooks não é ordenada, o consumidor pode reconsultar o estado atual do recurso e comparar o version.
Estado Atual do Pagamento
Devolve o mesmo formato do data dos eventos payment.*. Serve para reconciliar: como a entrega de webhooks não é ordenada, o consumidor pode reconsultar o estado atual do recurso e comparar o version. O id é o da movimentação financeira.