Registrar una suscripción de webhook

curl --request POST \
  --url https://slc.sandbox.lerian.net/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "<string>"
  ],
  "url": "<string>",
  "active": true,
  "description": "<string>",
  "headers": {},
  "secret": "<string>",
  "timeoutSeconds": 123
}
'

import requests

url = "https://slc.sandbox.lerian.net/webhooks"

payload = {
    "events": ["<string>"],
    "url": "<string>",
    "active": True,
    "description": "<string>",
    "headers": {},
    "secret": "<string>",
    "timeoutSeconds": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    events: ['<string>'],
    url: '<string>',
    active: true,
    description: '<string>',
    headers: {},
    secret: '<string>',
    timeoutSeconds: 123
  })
};

fetch('https://slc.sandbox.lerian.net/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://slc.sandbox.lerian.net/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'events' => [
        '<string>'
    ],
    'url' => '<string>',
    'active' => true,
    'description' => '<string>',
    'headers' => [
        
    ],
    'secret' => '<string>',
    'timeoutSeconds' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://slc.sandbox.lerian.net/webhooks"

	payload := strings.NewReader("{\n  \"events\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"headers\": {},\n  \"secret\": \"<string>\",\n  \"timeoutSeconds\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://slc.sandbox.lerian.net/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"headers\": {},\n  \"secret\": \"<string>\",\n  \"timeoutSeconds\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://slc.sandbox.lerian.net/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"events\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"headers\": {},\n  \"secret\": \"<string>\",\n  \"timeoutSeconds\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "active": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "events": [
    "<string>"
  ],
  "failureCount": 123,
  "id": "<string>",
  "lastDeliveryAt": "2023-11-07T05:31:56Z",
  "lastDeliveryStatus": 123,
  "successCount": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "description": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Registrar una suscripción de webhook

Registra una suscripción de webhook para el tenant de la solicitud. El secreto en bruto se usa únicamente para derivar un hash SHA-256 (nunca se persiste en texto plano); en BYOC el secreto de firma real proviene del Secret de Kubernetes del cliente. La presencia/el tipo de los campos se valida contra el esquema (422); los fallos de reglas de negocio devuelven problem+json con código 400/409/422.

POST

webhooks

curl --request POST \
  --url https://slc.sandbox.lerian.net/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "<string>"
  ],
  "url": "<string>",
  "active": true,
  "description": "<string>",
  "headers": {},
  "secret": "<string>",
  "timeoutSeconds": 123
}
'

import requests

url = "https://slc.sandbox.lerian.net/webhooks"

payload = {
    "events": ["<string>"],
    "url": "<string>",
    "active": True,
    "description": "<string>",
    "headers": {},
    "secret": "<string>",
    "timeoutSeconds": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    events: ['<string>'],
    url: '<string>',
    active: true,
    description: '<string>',
    headers: {},
    secret: '<string>',
    timeoutSeconds: 123
  })
};

fetch('https://slc.sandbox.lerian.net/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://slc.sandbox.lerian.net/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'events' => [
        '<string>'
    ],
    'url' => '<string>',
    'active' => true,
    'description' => '<string>',
    'headers' => [
        
    ],
    'secret' => '<string>',
    'timeoutSeconds' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://slc.sandbox.lerian.net/webhooks"

	payload := strings.NewReader("{\n  \"events\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"headers\": {},\n  \"secret\": \"<string>\",\n  \"timeoutSeconds\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://slc.sandbox.lerian.net/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"headers\": {},\n  \"secret\": \"<string>\",\n  \"timeoutSeconds\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://slc.sandbox.lerian.net/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"events\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"headers\": {},\n  \"secret\": \"<string>\",\n  \"timeoutSeconds\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "active": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "events": [
    "<string>"
  ],
  "failureCount": 123,
  "id": "<string>",
  "lastDeliveryAt": "2023-11-07T05:31:56Z",
  "lastDeliveryStatus": 123,
  "successCount": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "description": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json

events

string[] | null

requerido

Business event types this subscription is delivered.

Ejemplo:

["operation.settled", "operation.rejected"]

url

string<uri>

requerido

HTTPS endpoint that receives webhook deliveries for the request tenant.

Ejemplo:

"https://client.example.com/webhooks/slc"

active

boolean

Whether the subscription is active and eligible for delivery.

Ejemplo:

true

description

string

Optional human-readable label for the subscription.

Ejemplo:

"Primary settlement consumer"

headers

object

Optional static HTTP headers added to every delivery request to this endpoint.

Show child attributes

secret

string

Raw signing secret used only to derive the SHA-256 HMAC signing key; never persisted or echoed in cleartext. In BYOC the real signing secret comes from the client's Kubernetes Secret.

timeoutSeconds

integer<int32>

Optional per-delivery HTTP timeout in seconds; omitted or zero applies the service default (10s).

Ejemplo:

10

Respuesta

Created

active

boolean

requerido

Whether the subscription is active and eligible for delivery.

Ejemplo:

true

createdAt

string<date-time>

requerido

Subscription creation timestamp (RFC3339, UTC).

Ejemplo:

"2026-06-15T07:50:00Z"

events

string[] | null

requerido

Business event types this subscription is delivered.

Ejemplo:

["operation.settled", "operation.rejected"]

failureCount

integer<int64>

requerido

Cumulative count of failed delivery attempts.

Ejemplo:

3

string

requerido

Subscription id (UUID).

Ejemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

lastDeliveryAt

string<date-time> | null

requerido

Timestamp of the most recent delivery attempt (RFC3339, UTC); null when none has occurred.

Ejemplo:

"2026-06-15T07:50:00Z"

lastDeliveryStatus

integer<int32> | null

requerido

HTTP status code of the most recent delivery attempt; null when none has occurred.

Ejemplo:

200

successCount

integer<int64>

requerido

Cumulative count of successful deliveries.

Ejemplo:

128

updatedAt

string<date-time>

requerido

Subscription last-update timestamp (RFC3339, UTC).

Ejemplo:

"2026-06-15T07:50:00Z"

url

string

requerido

HTTPS endpoint that receives webhook deliveries.

Ejemplo:

"https://client.example.com/webhooks/slc"

description

string

Human-readable label for the subscription.

Ejemplo:

"Primary settlement consumer"

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Registrar una suscripción de webhook

Autorizaciones

Cuerpo

Respuesta