Atualizar endpoint de webhook
PUT · API de Integração v2
/v2/webhooks/endpoints/{id}Substitui o nome e a URL de um endpoint da empresa autenticada.
Para endpoint ativo, a alteração volta o estado local para PENDING_SYNC e solicita atualização no
provider. Para endpoint DISABLED, nome e URL são salvos, mas ele permanece desabilitado até a rota
de habilitação ser chamada explicitamente.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Parâmetros de caminho1
idintegerobrigatórioID do endpoint retornado pela criação/listagem.
Corpo da requisiçãoobrigatório
Novo nome e URL HTTPS pública.
application/json
nomestringobrigatóriourlstringobrigatórioRespostas4
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": "PENDING_SYNC",
"eventTypes": [
"agenda.compromisso.criado",
"agenda.compromisso.concluido",
"agenda.compromisso.atualizado",
"agenda.comentario.criado"
]
}Contrato de respostas
200Endpoint atualizado e sincronização solicitada.
Endpoint atualizado e sincronização solicitada.
application/json
eventTypesstring[]idintegernomestringstatusstringurlstring400Nome ou URL inválidos, ou endpoint não pertence ao cliente.
Nome ou URL inválidos, ou endpoint não pertence ao cliente.
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.