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

Request

Base URL
https://api.b2b.usezapay.com.br/v2
Auth
HTTP basic
TypeScript
https://skmtc.dev/usezapay/apis/zapi/docs/webhook/:hook_id/put.ts
A function with typed inputs. Its response is checked against the schema.

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

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

Changes

No recorded changes to this operation across all 1 revision of this API.