Sign in

v1

latestOpenAPI 3.1.02026-07-2678221359.6 KB
Webhook

Cadastrar Url Para Receber Webhooks

Este endpoint é utilizado para cadastrar um novo webhook. Webhooks são essenciais para receber notificações automáticas sobre eventos específicos em sua aplicação, incluíndo atualizaçãodo status da pesquisa de débitos veiculares, pagamentos, entre outros.

post/webhook/

Request body

urlstring required

Url do webhook para comunicação das mensagens

resource'vehicle_debt' | 'vehicle_debt_batch' | 'checkout' | 'autoradar' | 'payment_recurrence' | 'documents' | 'monitoring'

Example request

{
  "auth": {
    "prefix": "Bearer",
    "type": "Bearer",
    "value": "token"
  },
  "resource": "vehicle_debt",
  "url": "https://url-mockada.com.br"
}

Response

Criação com sucesso

idstring nullable required

Id único do webhook

urlstring required

Url do webhook para comunicação das mensagens

resource'vehicle_debt' | 'vehicle_debt_batch' | 'checkout' | 'autoradar' | 'payment_recurrence' | 'documents' | 'monitoring'
created_atstring

Data da criação do Webhook

updated_atstring

Data da ultima atualização do Webhook

Example response

{
  "created_at": "2023-10-24T15:41:54.506308",
  "id": "hook_123456",
  "resource": "vehicle_debts",
  "updated_at": "2023-10-24T16:42:54.506308",
  "url": "https://url-mockada.com.br"
}