List outbound webhooks

Lists persisted outbound webhooks (sent to clients). The flow_type query parameter is required. Dead-letter rows are surfaced transparently with status=“DEAD_LETTER”.

GET /v1/webhooks/outbound

List outbound webhooks

cURL

curl --request GET \
  --url https://api.example.com/v1/webhooks/outbound \
  --header 'Authorization: Bearer <token>'

200

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

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

Authorization · string

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

Parámetros de consulta

flow_type · string

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

Ejemplo:

"DICT"

entity_type · string

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

Ejemplo:

"CLAIM"

entity_id · string

Filter by entity id in UUID format.

Ejemplo:

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

Ejemplo:

["PENDING"]

request_id · string

Filter by originating request id.

Ejemplo:

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

created_after · string

Filter rows with created_at >= this RFC3339 timestamp.

Ejemplo:

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

created_before · string

Filter rows with created_at <= this RFC3339 timestamp.

Ejemplo:

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

limit · string

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

Ejemplo:

"20"

page · string

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

Ejemplo:

"1"

Respuesta

200

application/json

OK

items · object[] · requerido

Show child attributes

limit · integer<int64> · requerido

Ejemplo:

20

page · integer<int64> · requerido

Ejemplo:

1

totalItems · integer<int64> · requerido

Ejemplo:

42