FlaresendDocs
Webhooks

List webhook deliveries

The delivery attempts for one webhook, newest first.

GET/v1/webhooks/{id}/deliveriesAPI key

Each delivery is one event sent to this webhook. A delivery stays pending while it is being retried, and ends as success (your endpoint answered with a 2xx status) or failed. Results are ordered by creation time, newest first, and paginated with a cursor.

Path parameters

idstringpathrequired

The webhook ID.

Query parameters

limitnumberquerydefault: 25

How many deliveries to return, from 1 to 100.

cursorstringquery

The nextCursor from the previous page.

Response

dataWebhookDelivery[]

The deliveries.

Show delivery properties
idstring

The delivery ID, whd_…. Sent to your endpoint in the Flaresend-Delivery-Id header.

webhookIdstring

The webhook ID.

eventIdstring

The event ID, evt_…. Sent in the Flaresend-Event-Id header and as id in the payload. Test events start with evt_test_.

eventTypestring | null

For example email.delivered.

attemptnumber

How many times the delivery has been tried. 0 before the first try.

status'pending' | 'success' | 'failed'

pending while waiting or retrying.

responseCodenumber | null

The HTTP status of the last try. null when there was no response (timeout or network error).

responseBodystring | null

The first 1,024 characters of the last response body, or the error, for example timeout after 10s.

nextAttemptAtstring | null

When the next retry is due. null once the delivery is finished.

createdAtstring

ISO 8601 timestamp.

completedAtstring | null

When it ended as success or failed.

nextCursorstring | null

Pass it as cursor to get the next page. null on the last page.

Errors

StatusCodeWhen
404webhook_not_foundNo webhook with this ID in the project.