---
title: "Cadastrar Url Para Receber Webhooks"
method: POST
path: "/webhook/"
tags: ["Webhook"]
---

# Cadastrar Url Para Receber Webhooks

`POST /webhook/`

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.

## Request body

- WebhookRequestDTO
  - `url` string, required — Url do webhook para comunicação das mensagens
  - `resource` 'vehicle_debt' | 'vehicle_debt_batch' | 'checkout' | 'autoradar' | 'payment_recurrence' | 'documents' | 'monitoring'
  - `auth` AuthModel — Caso seja APIKey o campo no header será x-api-key: <value> Caso outros casos será Authorization: <prefix> <value>
    - `type` 'APIKey' | 'Token'
    - `value` string, required — Valor do token de autenticação ou APIKey
    - `prefix` 'Basic' | 'Bearer' | 'JWT'

## Response `201`

Criação com sucesso

- WebhookResponseDTOInput
  - `id` string, nullable, required — Id único do webhook
  - `url` string, required — Url do webhook para comunicação das mensagens
  - `resource` 'vehicle_debt' | 'vehicle_debt_batch' | 'checkout' | 'autoradar' | 'payment_recurrence' | 'documents' | 'monitoring'
  - `auth` AuthModel — Caso seja APIKey o campo no header será x-api-key: <value> Caso outros casos será Authorization: <prefix> <value>
    - `type` 'APIKey' | 'Token'
    - `value` string, required — Valor do token de autenticação ou APIKey
    - `prefix` 'Basic' | 'Bearer' | 'JWT'
  - `created_at` string — Data da criação do Webhook
  - `updated_at` string — Data da ultima atualização do Webhook

## Other responses

- `400` — Formato da requisição inválida
- `422` — Validation Error
- `500` — Erro interno
- `503` — Serviço temporariamente indisponível

---

[API](https://skmtc.net/usezapay/apis/zapi.md) · [All operations](https://skmtc.net/usezapay/apis/zapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usezapay/zapi/versions/50c96157fff4/schema)