List outbound webhooks

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

package main

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

func main() {

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

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

}

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

fetch('https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

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

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

print(response.text)

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

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

GET

webhooks

outbound

List outbound webhooks

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

package main

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

func main() {

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

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

}

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

fetch('https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

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

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

print(response.text)

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

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

Authorization

string

The authorization token. Important: This header is required only if your environment has the Access Manager plugin enabled.

Query Parameters

flow_type

string

Required. Outbound flow type. Uppercased server-side. One of: DICT, PAYMENT, COLLECTION, PIX, TRANSFER, REFUND, RECURRING.

Example:

"DICT"

entity_type

string

Filter by internal entity type (e.g. CLAIM, REFUND, INFRACTION_REPORT under DICT; CASHIN, CASHOUT under TRANSFER/REFUND).

Example:

"CLAIM"

entity_id

string

Filter by entity id in UUID format.

Example:

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

status

string[]

Filter by status: PENDING, PROCESSING, SENT, FAILED, DEAD_LETTER. Multiple comma-separated values are OR-matched. DEAD_LETTER is a virtual, API-only value that surfaces dead-lettered webhooks.

Example:

["PENDING"]

request_id

string

Filter by originating request id.

Example:

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

created_after

string

Filter rows with created_at >= this RFC3339 timestamp.

Example:

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

created_before

string

Filter rows with created_at <= this RFC3339 timestamp.

Example:

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

limit

string

Items per page (integer 1-100, default 20).

Example:

"20"

page

string

Page number (integer >= 1, default 1).

Example:

"1"

Response

items

object[]

required

Show child attributes

limit

integer<int64>

required

Example:

20

page

integer<int64>

required

Example:

1

totalItems

integer<int64>

required

Example:

42

DICT API

Claims API

MED · Infractions

MED · Fraud markers

MED · Refund requests

MED · Statistics

Transactions API

QR Codes API

Collections API

Funds Recovery API

Reconciliation API

Pix Automático API

Schedules API

Transaction Reports API

Transaction times

Webhooks API

Error handling

List outbound webhooks

Authorizations

Headers

Query Parameters

Response