Registrar endpoint de webhook

Registra un endpoint de webhook que recibe las entregas de eventos del plano de control. El secreto provisto se cifra en reposo con AES-256-GCM. El arreglo eventTypes es obligatorio y debe contener constantes canónicas de eventos del plano de control (str.operation., str.readiness., str.certificate., str.approval.). Idempotente: reenviar la misma clave X-Idempotency con el mismo cuerpo devuelve la respuesta en caché.

POST /v1/str/webhooks

Registrar endpoint de webhook

cURL

curl --request POST \
  --url https://spb.sandbox.lerian.net/v1/str/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventTypes": [
    "<string>"
  ],
  "secret": "<string>",
  "url": "<string>",
  "isActive": true,
  "metadata": {}
}
'

201

{
  "correlationId": "<string>",
  "webhook": {
    "createdAt": "<string>",
    "eventTypes": [
      "<string>"
    ],
    "isActive": true,
    "messageTypes": [
      "<string>"
    ],
    "updatedAt": "<string>",
    "url": "<string>",
    "webhookId": "<string>",
    "metadata": {}
  }
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string

Idempotency key (canonical).

X-Idempotency-Key · string

Idempotency key (legacy alias).

X-TTL · string

Idempotency key TTL in seconds (overrides the configured default).

Ejemplo:

"86400"

Cuerpo

application/json

eventTypes · string[] | null · requerido

Canonical control-plane event types to subscribe to (str.operation., str.readiness., str.certificate., str.approval.); at least one required.

Ejemplo:

[
  "str.operation.accepted",
  "str.operation.received"
]

secret · string · requerido

Shared signing secret (16-512 chars); encrypted at rest with AES-256-GCM and never returned.

Ejemplo:

"whsec_..."

url · string · requerido

HTTPS endpoint that receives event deliveries; max 2048 chars and subject to an SSRF check.

Ejemplo:

"https://example.com/webhooks/str-events"

isActive · boolean

Whether the endpoint is active and eligible to receive deliveries; defaults to active when omitted.

metadata · object

Arbitrary client-defined key/value metadata stored with the endpoint.

Show child attributes

Respuesta

201

application/json

Created

correlationId · string · requerido

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

Ejemplo:

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

webhook · object · requerido

The created, fetched, or updated webhook endpoint.

Show child attributes