Skip to main content

Inbound Webhooks (Read)

List the inbound webhooks you may read and fetch their submissions, one at a time or in pages.

List the inbound webhooks I am permitted to read

GET/api/inbound-webhooks

Filtered by role inside the query, so totals never reveal webhooks the caller cannot see.

Authentication: Admin session token (Authorization: Bearer <token>)

Responses

StatusDescriptionBody
200Readable webhooks.

Open in Swagger (opens in a new tab)

List submissions

GET/api/inbound-webhooks/{id}/submissions

Authentication: Admin session token (Authorization: Bearer <token>)

Parameters

NameInTypeRequiredDescription
idpathstringyes
limitquerynumbernoDefault: 50.
offsetquerynumbernoDefault: 0.
dateFromquerystring (date-time)noISO 8601 timestamp - submissions received at or after it.
dateToquerystring (date-time)noISO 8601 timestamp - submissions received at or before it. A date-only value means midnight UTC, so it excludes that day.

Responses

StatusDescriptionBody
200
404No such webhook, or the caller holds none of its roles.

Open in Swagger (opens in a new tab)

Get one submission

GET/api/inbound-webhooks/{id}/submissions/{submissionId}

Authentication: Admin session token (Authorization: Bearer <token>)

Parameters

NameInTypeRequiredDescription
idpathstringyes
submissionIdpathstringyes

Responses

StatusDescriptionBody
200
404No such webhook or submission, or the caller holds none of its roles.

Open in Swagger (opens in a new tab)

Source: apps/api/openapi.json.