Actualizar una suscripción de webhook

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

import requests

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

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

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

print(response.text)

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

fetch('https://slc.sandbox.lerian.net/webhooks/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => true,
    'description' => '<string>',
    'events' => [
        '<string>'
    ],
    'headers' => [
        
    ],
    'secret' => '<string>',
    'timeoutSeconds' => 123,
    'url' => '<string>'
  ]),
  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/{id}"

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

	req, _ := http.NewRequest("PUT", 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.put("https://slc.sandbox.lerian.net/webhooks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"headers\": {},\n  \"secret\": \"<string>\",\n  \"timeoutSeconds\": 123,\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

PUT

webhooks

{id}

Actualizar una suscripción de webhook

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

import requests

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

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

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

print(response.text)

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

fetch('https://slc.sandbox.lerian.net/webhooks/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => true,
    'description' => '<string>',
    'events' => [
        '<string>'
    ],
    'headers' => [
        
    ],
    'secret' => '<string>',
    'timeoutSeconds' => 123,
    'url' => '<string>'
  ]),
  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/{id}"

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

	req, _ := http.NewRequest("PUT", 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.put("https://slc.sandbox.lerian.net/webhooks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"headers\": {},\n  \"secret\": \"<string>\",\n  \"timeoutSeconds\": 123,\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

Parámetros de ruta

string

requerido

Subscription id (UUID).

Ejemplo:

"0190b5a0-0000-7000-8000-0000000000aa"

Cuerpo

application/json

active

boolean | null

Activation flag; a pointer so null/omitted leaves the stored value unchanged.

Ejemplo:

true

description

string

New description; omitted leaves the stored value unchanged.

Ejemplo:

"Primary settlement consumer"

events

string[] | null

Replacement event-type list; omitted leaves the stored list unchanged.

Ejemplo:

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

headers

object

Replacement static HTTP headers; omitted leaves the stored headers unchanged.

Show child attributes

secret

string

New raw signing secret; when present it rotates the signing secret (rehashed, never stored in cleartext). Omitted leaves it unchanged.

timeoutSeconds

integer<int32>

New per-delivery HTTP timeout in seconds; zero or omitted leaves it unchanged.

Ejemplo:

10

url

string<uri>

New HTTPS endpoint; omitted leaves the stored value unchanged.

Ejemplo:

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

Respuesta

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)

Actualizar una suscripción de webhook

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta