Register a webhook subscription

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"
}

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"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Body

application/json

events

string[] | null

required

Business event types this subscription is delivered.

Example:

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

url

string<uri>

required

HTTPS endpoint that receives webhook deliveries for the request tenant.

Example:

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

active

boolean

Whether the subscription is active and eligible for delivery.

Example:

true

description

string

Optional human-readable label for the subscription.

Example:

"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).

Example:

10

Response

Created

active

boolean

required

Whether the subscription is active and eligible for delivery.

Example:

true

createdAt

string<date-time>

required

Subscription creation timestamp (RFC3339, UTC).

Example:

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

events

string[] | null

required

Business event types this subscription is delivered.

Example:

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

failureCount

integer<int64>

required

Cumulative count of failed delivery attempts.

Example:

3

string

required

Subscription id (UUID).

Example:

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

lastDeliveryAt

string<date-time> | null

required

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

Example:

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

lastDeliveryStatus

integer<int32> | null

required

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

Example:

200

successCount

integer<int64>

required

Cumulative count of successful deliveries.

Example:

128

updatedAt

string<date-time>

required

Subscription last-update timestamp (RFC3339, UTC).

Example:

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

url

string

required

HTTPS endpoint that receives webhook deliveries.

Example:

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

description

string

Human-readable label for the subscription.

Example:

"Primary settlement consumer"

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Register a webhook subscription

Authorizations

Body

Response