PATCH
Atualizar webhook

Authorizations

X-API-KEY
string
header
required

Chave de API da aplicação (TTL de 2h). Renove via POST /auth com clientId/clientSecret. Em caso de 401, regenere a apiKey.

Path Parameters

id
string<uuid>
required

Identificador (UUID) do webhook.

Body

application/json

Corpo para atualizar parcialmente um webhook. Apenas os campos enviados são alterados.

url
string<uri>

Nova URL de destino (HTTPS, não-localhost).

Example:

"https://api.your-app.com/webhooks/malvo"

event
enum<string>

Novo tipo de evento assinado.

Available options:
all,
item/created,
item/updated,
item/error,
item/deleted,
item/waiting_user_input,
item/login_succeeded,
transactions/created,
transactions/updated,
transactions/deleted,
connector/status_updated,
payment_intent/created,
payment_intent/waiting_payer_authorization,
payment_intent/completed,
payment_intent/error,
scheduled_payment/created,
scheduled_payment/completed,
scheduled_payment/error,
scheduled_payment/canceled,
automatic_pix_payment/created,
automatic_pix_payment/completed,
automatic_pix_payment/error,
automatic_pix_payment/canceled,
smart_transfer_preauthorization/completed,
smart_transfer_preauthorization/error,
smart_transfer_payment/completed,
smart_transfer_payment/error,
payment_request/updated
Example:

"all"

headers
object
write-only

Write-only / API-only. Substitui os headers customizados de entrega. Mecanismo para rotacionar segredos de autenticação. Nunca é retornado.

Example:
disabled
string<date-time> | null

Defina um timestamp ISO 8601 para desabilitar o webhook, ou null para reativá-lo.

Example:

"2026-06-12T08:15:00.000Z"

Response

Objeto Webhook atualizado (sem headers).

Webhook registrado na aplicação. O campo headers é write-only e nunca aparece neste objeto de resposta.

id
string<uuid>
required

Identificador único do webhook, gerado pela Malvo.

Example:

"39e1d11f-3c12-44a8-a788-75c5747e1a8e"

event
enum<string>
required

Tipo de evento assinado (um valor do enum, incluindo all).

Available options:
all,
item/created,
item/updated,
item/error,
item/deleted,
item/waiting_user_input,
item/login_succeeded,
transactions/created,
transactions/updated,
transactions/deleted,
connector/status_updated,
payment_intent/created,
payment_intent/waiting_payer_authorization,
payment_intent/completed,
payment_intent/error,
scheduled_payment/created,
scheduled_payment/completed,
scheduled_payment/error,
scheduled_payment/canceled,
automatic_pix_payment/created,
automatic_pix_payment/completed,
automatic_pix_payment/error,
automatic_pix_payment/canceled,
smart_transfer_preauthorization/completed,
smart_transfer_preauthorization/error,
smart_transfer_payment/completed,
smart_transfer_payment/error,
payment_request/updated
Example:

"all"

url
string<uri>
required

URL HTTPS de destino, validada no momento de criar/atualizar.

Example:

"https://api.your-app.com/webhooks/malvo"

createdAt
string<date-time>
required

Data/hora de criação (ISO 8601, UTC, milissegundos).

Example:

"2026-06-10T12:00:00.000Z"

updatedAt
string<date-time>
required

Data/hora da última atualização (ISO 8601, UTC, milissegundos).

Example:

"2026-06-10T12:00:00.000Z"

disabled
string<date-time> | null
required

Timestamp (ISO 8601) de quando o webhook foi desabilitado; null quando ativo. Configurável via PATCH.

Example:

null