v1

latestOpenAPI 3.1.02026-07-2678221359.6 KB
Webhook

Atualizar Um Webhook

Este endpoint é usado para atualizar as configurações de um webhook existente. Use-o para modificar parâmetros como a URL do destino, os eventos a serem monitorados ou outras configurações específicas.

put/webhook/{hook_id}/

Path parameters

hook_idstring required

Request body

urlstring nullable

Url do webhook para comunicação das mensagens

Example request

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

Response

Webhook pesquisado

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"
}