Skip to main content
GET
List webhook deliveries
Coming soon: The Webhooks API is currently under design review. This documentation describes the target interface and may change before release.

Overview

Retrieves the delivery history of a webhook subscription: which events were sent, whether they were acknowledged, the HTTP status code your endpoint returned, the number of attempts and the last error, if any.
Important: pending deliveries are still being retried with exponential backoff. A delivery is marked as failed after 72 hours of unsuccessful attempts.
Use this endpoint to debug your integration or to recover from an outage on your side: failed deliveries carry the event id and type, and since consumption events always contain accumulated totals, calling the corresponding GET consumptions endpoint is enough to converge to the current state.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

subscriptionId
string<uuid>
required

The unique identifier of the webhook subscription

Query Parameters

status
enum<string>

Filter deliveries by status.

Available options:
pending,
succeeded,
failed
eventType
enum<string>

Filter deliveries by event type.

Available options:
employee.consumption.registered,
company.payroll-cycle.closed,
employee.committed-expense.requested,
employee.committed-expense.finished,
employee.committed-expense.cancelled,
employee.committed-expense.payment.executed,
employee.committed-expense.payment.cancelled

Response

Webhook deliveries successfully retrieved

deliveries
object[]
required

List of webhook deliveries, most recent first