Skip to main content
POST
Cadastrar webhook

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

api-key
string
header
required

Obrigatório. Sua chave API.

Body

application/json
tipo
enum<string>
required

Indica o tipo de webhook. Valores aceitos: posicao, status ou mensagens

Available options:
posicao,
status,
mensagens
url
string
required

Indica a URL que receberá o evento

responsabilidade
enum<string>
required

Obrigatório se o usuário autenticado não for de "empresa". Define quem é o responsável pelo evento. Valores aceitos: solicitante ou corrida. IMPORTANTE: para usuários "empresa", a responsabilidade será definida automaticamente.

Available options:
solicitante,
corrida

Response

200 - application/json

Sucesso

The response is of type object.