Saltar al contenido principal
PATCH
/
v1
/
webhooks
/
{webhookId}
curl --request PATCH \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "enabled": false
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Operations webhook",
  "endpointUrl": "https://hooks.example.com/transfer-events",
  "enabled": false,
  "eventTypes": [
    "transfer.completed"
  ],
  "createdAt": "2026-02-01T15:30:00Z",
  "updatedAt": "2026-02-01T16:00:00Z"
}

Autorizaciones

​
Authorization
string
header
requerido

Autenticación mediante token JWT Bearer. El tenantId se deriva del token bearer o del contexto autenticado de la solicitud y no se proporciona a través de X-Organization-Id.

Encabezados

​
X-Idempotency
string
requerido

Clave de idempotencia requerida para reintentos seguros. Utilice un UUID v4 o un identificador de negocio único. Si se envía la misma clave nuevamente y la solicitud original ya fue procesada, se devuelve la respuesta almacenada en caché.

Consulte Reintentos e idempotencia para más detalles.

Maximum string length: 255

Parámetros de ruta

​
webhookId
string<uuid>
requerido

El identificador único del registro de webhook a modificar.

Cuerpo

application/json

Solo se actualizan los campos presentes en la solicitud. Enviar eventTypes como null borra el filtro para que el registro reciba todos los tipos de evento.

​
name
string

Un nombre legible para el registro.

Ejemplo:

"Operations webhook"

​
endpointUrl
string<uri>

El endpoint que recibe las entregas de eventos. Debe ser una URL HTTPS.

Pattern: ^https://
Ejemplo:

"https://hooks.example.com/transfer-events"

​
enabled
boolean

Si el registro está activo.

Ejemplo:

true

​
eventTypes
string[] | null

Los tipos de evento a los que se suscribe este endpoint. Envíe null para borrar el filtro y recibir todos los tipos de evento.

Maximum array length: 64
Ejemplo:
["transfer.completed"]

Respuesta

Indica que el registro de webhook fue actualizado.

Las llamadas repetidas con la misma clave X-Idempotency reproducen la respuesta en caché.

Consulte Reintentos e idempotencia para más detalles.

​
id
string<uuid>
requerido

El identificador único del registro de webhook.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

​
name
string
requerido

El nombre legible del registro.

Ejemplo:

"Operations webhook"

​
endpointUrl
string<uri>
requerido

El endpoint HTTPS que recibe las entregas de eventos.

Ejemplo:

"https://hooks.example.com/transfer-events"

​
enabled
boolean
requerido

Si el registro está activo.

Ejemplo:

true

​
createdAt
string<date-time>
requerido

La marca de tiempo de cuando se creó el registro.

Ejemplo:

"2026-02-01T15:30:00Z"

​
updatedAt
string<date-time>
requerido

La marca de tiempo de la última actualización.

Ejemplo:

"2026-02-01T15:30:00Z"

​
eventTypes
string[]

Los tipos de evento a los que se suscribe este endpoint. Ausente cuando el registro recibe todos los tipos de evento.

Ejemplo:
["transfer.completed"]