Skip to main content
POST
Criar webhook.
Cria uma configuração de webhook para o parceiro identificado automaticamente pelo token de acesso.

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

A credencial é obrigatória para Basic e JWT. Pode existir apenas um webhook de cada tipo por parceiro.

Authorizations

Authorization
string
header
required

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

Body

application/json
tipo
enum<integer>
required

1: Cliente (fluxo em roadmap); 2: Simulação (fluxo em roadmap); 3: Pedido (envio disponível).

Available options:
1,
2,
3
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

Obrigatória para Basic e JWT. Não deve ser enviada quando não houver autenticação.

Response

Webhook criado com sucesso.