Skip to main content
POST
/
cadastrarWebhook
Cadastrar webhook
curl --request POST \
  --url https://api-vendas.taximachine.com.br/api/integracao/cadastrarWebhook \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "url": "<string>"
}
'
{
  "success": true,
  "response": {
    "mensagem": "Webhook criado com sucesso"
  }
}

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 ou status

Available options:
posicao,
status
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.