Get inbound webhook by id

Gets a single inbound webhook by id. Intended for low-frequency operator use.

GET /v1/webhooks/inbound/{id}

Get inbound webhook by id

cURL

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

200

{
  "attemptCount": 0,
  "createdAt": "2026-05-21T12:00:00Z",
  "entityType": "DICT_CLAIM",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "maxRetries": 3,
  "receivedAt": "2026-05-21T12:00:00Z",
  "requestId": "560d59b9-3c74-46f8-be67-fee895b8e89e",
  "source": "BTG",
  "status": "RECEIVED",
  "updatedAt": "2026-05-21T12:00:00Z",
  "errorMessage": "timeout calling downstream",
  "lastAttemptAt": "2026-05-21T12:00:00Z",
  "nextRetryAt": "2026-05-21T12:00:00Z",
  "payload": "<unknown>",
  "processedAt": "2026-05-21T12:00:00Z"
}

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

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

entityType · string · requerido

Ejemplo:

"DICT_CLAIM"

id · string · requerido

Ejemplo:

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

maxRetries · integer<int64> · requerido

Ejemplo:

3

receivedAt · string<date-time> · requerido

Ejemplo:

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

requestId · string · requerido

Ejemplo:

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

source · string · requerido

Ejemplo:

"BTG"

status · enum<string> · requerido

Opciones disponibles: RECEIVED, PROCESSING, SENT, FAILED

Ejemplo:

"RECEIVED"

updatedAt · string<date-time> · requerido

Ejemplo:

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

errorMessage · string

Ejemplo:

"timeout calling downstream"

lastAttemptAt · string<date-time>

Ejemplo:

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

nextRetryAt · string<date-time>

Ejemplo:

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

payload · any

processedAt · string<date-time>

Ejemplo:

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