Skip to main content
GET
List webhook deliveries

Authorizations

Authorization
string
header
required

Partner API Bearer key: Authorization: Bearer <key>. Keys are created only through authorized portal or staff flows.

Query Parameters

event_type
enum<string>

Exact delivered event type: a Partner lifecycle event, or a Case or Mahnservice event sent to a company-scoped subscription.

Available options:
company.created,
company.case_submission_readiness.changed,
company.access.confirmed,
company.access.revoked,
company.access.restored,
company.user.added,
company.user.revoked,
company.user.activated,
company.user.invite_expired,
order.submitted,
order.withdrawn,
order.rejected,
order.accepted,
order.expired,
mandate.created,
mandate.state.changed,
mandate.status_update.published,
mandate.balance_updated,
order.message.created,
mandate.message.created,
request_to_client.created,
request_to_client.answered,
payment.reported,
statement.published,
statement.cancelled,
single_mandate_statement.published,
single_mandate_statement.cancelled,
invoice.created,
invoice.paid,
invoice.cancelled,
invoice.written_off,
dunning.level_advanced,
dunning.handed_to_collection
limit
integer
default:10

Number of results to return (maximum 100).

Required range: 1 <= x <= 100
offset
integer
default:0

Zero-based result offset.

Required range: x >= 0
status
enum<string>

Exact delivery state: pending, delivering, retrying, success, or failed.

Available options:
delivering,
failed,
pending,
retrying,
success
updated_since
string<date-time>

Return rows changed at or after this timezone-aware RFC 3339 timestamp. Results are ordered by updated_at and id.

webhook
string<uuid>

Return only deliveries for this webhook subscription's UUID.

Response

count
integer
required

Total number of matching resources.

Example:

123

results
object[]
required

Resources returned for the requested page.

next
string<uri> | null

URL for the next page, or null when this is the last page.

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous
string<uri> | null

URL for the previous page, or null when this is the first page.

Example:

"http://api.example.org/accounts/?offset=200&limit=100"