Webhooks
Listar endpoints de webhook
GET · API de Integração v2
GET
/v2/webhooks/endpointsRetorna os endpoints configurados pela empresa autenticada e seus tipos de evento inscritos.
O resultado nunca inclui dados de outros clientes, IDs internos do provider ou segredo de assinatura.
Use o campo id retornado nas rotas de atualização, inscrição, habilitação e desabilitação.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Respostas3
Exemplos ilustrativos · nenhuma requisição é enviada
200 · Sucesso
- Quando acontece
- A operação foi concluída.
- Como tratar
- Leia os dados retornados; em listagens, confira também a paginação.
Exemplo declarado no OpenAPI · application/json
[
{
"id": 123,
"nome": "ERP Jurídico",
"url": "https://erp.exemplo.com/webhooks/expedit",
"status": "ACTIVE",
"eventTypes": [
"agenda.compromisso.criado",
"agenda.compromisso.concluido",
"agenda.compromisso.atualizado",
"agenda.comentario.criado"
]
}
]Contrato de respostas
200Endpoints do cliente autenticado.
Endpoints do cliente autenticado.
application/json
eventTypesstring[]idintegerformato: int64
nomestringstatusstringurlstring401Chave de API ausente ou inválida.
Chave de API ausente ou inválida.
O contrato não declara um corpo para esta resposta.
403Chave sem permissão para esta operação.
Chave sem permissão para esta operação.
O contrato não declara um corpo para esta resposta.