Get an Outbound Webhook

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound/{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://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "attemptCount": 0,
  "createdAt": "2026-05-21T12:00:00Z",
  "deadLetter": false,
  "deliveredAt": "2026-05-21T12:00:00Z",
  "entityId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "entityType": "DICT_ENTRY",
  "errorMessage": "timeout calling target URL",
  "failedAt": "2026-05-21T12:00:00Z",
  "failureReason": "max_retries_exceeded",
  "flowType": "DICT",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "lastAttemptAt": "2026-05-21T12:00:00Z",
  "maxRetries": 3,
  "movedBy": "system",
  "nextRetryAt": "2026-05-21T12:00:00Z",
  "payload": {},
  "requestId": "560d59b9-3c74-46f8-be67-fee895b8e89e",
  "status": "PENDING",
  "targetUrl": "https://client.example.com/webhooks",
  "updatedAt": "2026-05-21T12:00:00Z"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

GET

webhooks

outbound

{id}

Get an Outbound Webhook

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound/{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://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "attemptCount": 0,
  "createdAt": "2026-05-21T12:00:00Z",
  "deadLetter": false,
  "deliveredAt": "2026-05-21T12:00:00Z",
  "entityId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "entityType": "DICT_ENTRY",
  "errorMessage": "timeout calling target URL",
  "failedAt": "2026-05-21T12:00:00Z",
  "failureReason": "max_retries_exceeded",
  "flowType": "DICT",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "lastAttemptAt": "2026-05-21T12:00:00Z",
  "maxRetries": 3,
  "movedBy": "system",
  "nextRetryAt": "2026-05-21T12:00:00Z",
  "payload": {},
  "requestId": "560d59b9-3c74-46f8-be67-fee895b8e89e",
  "status": "PENDING",
  "targetUrl": "https://client.example.com/webhooks",
  "updatedAt": "2026-05-21T12:00:00Z"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Outbound webhook id (UUID)

Response

attemptCount

integer

Example:

0

createdAt

string<date-time>

Example:

"2026-05-21T12:00:00Z"

deadLetter

boolean

Dead-letter-only fields. Populated when DeadLetter is true.

Example:

false

deliveredAt

string<date-time>

Example:

"2026-05-21T12:00:00Z"

entityId

string

Example:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

entityType

string

Example:

"DICT_ENTRY"

errorMessage

string

Example:

"timeout calling target URL"

failedAt

string<date-time>

Example:

"2026-05-21T12:00:00Z"

failureReason

string

Example:

"max_retries_exceeded"

flowType

string

Example:

"DICT"

string

Example:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

lastAttemptAt

string<date-time>

Example:

"2026-05-21T12:00:00Z"

maxRetries

integer

Example:

3

movedBy

string

Example:

"system"

nextRetryAt

string<date-time>

Example:

"2026-05-21T12:00:00Z"

payload

object

requestId

string

Example:

"560d59b9-3c74-46f8-be67-fee895b8e89e"

status

enum<string>

Available options:

PENDING,

PROCESSING,

SENT,

FAILED,

DEAD_LETTER

Example:

"PENDING"

targetUrl

string

Example:

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

updatedAt

string<date-time>

Example:

"2026-05-21T12:00:00Z"

⌘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)

Get an Outbound Webhook

Authorizations

Path Parameters

Response