Desabilitar endpoint de webhook
POST · API de Integração v2
/v2/webhooks/endpoints/{id}/desabilitarInterrompe novas entregas para o endpoint e solicita sua desativação no provider.
É idempotente: chamar novamente para um endpoint já DISABLED mantém o mesmo estado. Eventos já
aceitos pelo provider podem ter sido processados antes da desativação ser efetivada.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Parâmetros de caminho1
idintegerobrigatórioID do endpoint retornado pela criação/listagem.
Respostas4
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": "DISABLED",
"eventTypes": [
"agenda.compromisso.criado",
"agenda.compromisso.concluido",
"agenda.compromisso.atualizado",
"agenda.comentario.criado"
]
}Contrato de respostas
200Endpoint desabilitado.
Endpoint desabilitado.
application/json
eventTypesstring[]idintegernomestringstatusstringurlstring400Endpoint não pertence ao cliente autenticado.
Endpoint não pertence ao cliente autenticado.
O contrato não declara um corpo para esta resposta.
401Chave 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.
