Substituir inscrições de eventos
PUT · API de Integração v2
/v2/webhooks/endpoints/{id}/subscriptionsDefine o conjunto final de eventos que o endpoint receberá. Esta operação substitui todas as inscrições anteriores; não adiciona parcialmente ao conjunto existente.
Envie ao menos um tipo. Para endpoint ativo, a troca solicita sincronização com o provider. Para
endpoint DISABLED, as inscrições são salvas e permanecem inativas até a habilitação explícita.
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
Conjunto final de tipos de evento; substitui completamente o conjunto atual.
application/json
eventTypesstring[]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": "PENDING_SYNC",
"eventTypes": [
"agenda.compromisso.criado",
"agenda.compromisso.concluido",
"agenda.compromisso.atualizado",
"agenda.comentario.criado"
]
}Contrato de respostas
200Inscrições substituídas e sincronização solicitada.
Inscrições substituídas e sincronização solicitada.
application/json
eventTypesstring[]idintegernomestringstatusstringurlstring400Lista vazia, tipo inválido ou endpoint fora do cliente.
Lista vazia, tipo inválido ou endpoint fora do 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.