Get outbound webhook by id

Gets a single outbound webhook by id. Dead-letter rows are resolved transparently and surfaced with status=“DEAD_LETTER” and additional dead-letter fields populated.

GET /v1/webhooks/outbound/{id}

Get outbound webhook by id

cURL

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

200

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

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 ruta

id · string · requerido

Outbound webhook id (UUID).

Ejemplo:

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

Respuesta

200

application/json

OK

attemptCount · integer<int64> · requerido

Ejemplo:

0

createdAt · string<date-time> · requerido

Ejemplo:

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

entityId · string · requerido

Ejemplo:

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

entityType · string · requerido

Ejemplo:

"DICT_ENTRY"

flowType · string · requerido

Ejemplo:

"DICT"

id · string · requerido

Ejemplo:

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

maxRetries · integer<int64> · requerido

Ejemplo:

3

requestId · string · requerido

Ejemplo:

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

status · enum<string> · requerido

Opciones disponibles: PENDING, PROCESSING, SENT, FAILED, DEAD_LETTER

Ejemplo:

"PENDING"

updatedAt · string<date-time> · requerido

Ejemplo:

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

deadLetter · boolean

Ejemplo:

false

deliveredAt · string<date-time>

Ejemplo:

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

errorMessage · string

Ejemplo:

"timeout calling target URL"

failedAt · string<date-time>

Ejemplo:

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

failureReason · string

Ejemplo:

"max_retries_exceeded"

lastAttemptAt · string<date-time>

Ejemplo:

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

movedBy · string

Ejemplo:

"outbound-worker"

nextRetryAt · string<date-time>

Ejemplo:

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

payload · any

targetUrl · string

Ejemplo:

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