Skip to main content
PUT
Editar webhook.
Atualiza a URL e a autenticação de um webhook já cadastrado.

Tipos de webhook

Os tipos Cliente (1) e Simulação (2) podem ser configurados, mas ainda não enviam notificações. Atualmente, apenas o tipo Pedido (3) está disponível para os eventos suportados.

Tipos de autenticação

Quando a credencial é omitida, a credencial atual é preservada. Ao selecionar autenticação 1 (Nenhuma), a credencial armazenada é removida.

Authorizations

Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação

Path Parameters

tipo
enum<integer>
required

Tipo do webhook:

  • 1 — Cliente: configuração disponível; fluxo de envio em roadmap.
  • 2 — Simulação: configuração disponível; fluxo de envio em roadmap.
  • 3 — Pedido: envio disponível para os eventos suportados.
Available options:
1,
2,
3

Body

application/json
url
string<uri>
required

URL HTTP ou HTTPS que receberá as notificações.

tipoAutenticacao
enum<integer>
required

1: Nenhuma; 2: Basic; 3: JWT.

Available options:
1,
2,
3
credencial
string | null

Quando omitida, mantém a credencial atual. É removida quando o tipo de autenticação é Nenhuma.

Response

Webhook atualizado com sucesso.