Saltar al contenido principal
GET
/
v1
/
webhooks
/
{webhookId}
Obtener un Registro de Webhook
curl --request GET \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Operations webhook",
  "endpointUrl": "https://hooks.example.com/transfer-events",
  "enabled": true,
  "eventTypes": [
    "transfer.completed"
  ],
  "createdAt": "2026-02-01T15:30:00Z",
  "updatedAt": "2026-02-01T15:30: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.

Parámetros de ruta

webhookId
string<uuid>
requerido

El identificador único del registro de webhook.

Respuesta

Indica que el registro de webhook fue encontrado y se devuelven sus 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"]