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

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 cuyo secreto será rotado.

Respuesta

Indica que se generó un nuevo secreto de firma. El signingSecret solo se devuelve en esta respuesta.

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"

​
signingSecret
string
requerido

El secreto de firma recién generado, devuelto únicamente en esta respuesta. El secreto anterior deja de ser válido.

Ejemplo:

"whsec_example_rotated_not_a_real_secret"

​
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"]