Events | Bitnob API Reference

Overview

Events are individual webhook delivery attempts. Every time Bitnob posts a payload to one of your webhook endpoints, it records an event with the HTTP status, attempt count, and any error. Use these endpoints to audit deliveries, debug failing webhooks, and re-send events your endpoint missed.

All event endpoints are scoped to a webhook — pass webhook_id as a query parameter.

List eventsGET/events
Get eventGET/events/:id
Retry event deliveryPOST/events/:id/retry

List Events

Use Case

Returns webhook delivery events for a webhook. Use it to monitor delivery health and surface failures for retry.

List Events

Query Parameters

webhook_idstring (uuid)Required

The webhook whose delivery events you want to list.

Event Fields

objectstring

Always `event`.

idstring (uuid)

Stable identifier for this delivery event. Pass it to the get and retry endpoints.

webhook_idstring (uuid)

The webhook endpoint this event was delivered to.

typestring

The event type that triggered the delivery (e.g. `transaction.completed`, `wallet.created`).

delivery_statusstring

Outcome of the delivery: `success`, `failed`, or `retrying`.

delivery_attemptsinteger

Number of attempts made so far.

max_attemptsinteger

Maximum attempts before the event is marked permanently failed.

http_status_codeinteger

HTTP status your endpoint returned on the last attempt. `0` when the request never got a response (timeout, DNS, TLS error).

error_messagestring

Human-readable failure reason. Empty on a successful delivery.

created_atstring (date-time)

RFC 3339 timestamp of when the event was created.

List Events Response

Get Event

Use Case

Returns a single event delivery by ID. Use it to re-fetch the latest delivery status after a retry.

Get Event

Path & Query Parameters

idstring (uuid)Required

The delivery event to retrieve.

webhook_idstring (uuid)Required

The webhook the event belongs to. Passed as a query parameter.

Same shape as List Events

The response is a single event object — the same field shape as each entry in List Events.

Get Event Response

Retry Event Delivery

Use Case

Re-sends a failed event to the webhook URL as a fresh delivery attempt. Use this after your endpoint has recovered from downtime.

Retry Event Delivery

Path Parameters

idstring (uuid)Required

The event to re-deliver.

Response

Returns HTTP 200 once the retry is queued. Poll Get Event for the outcome of the new attempt — delivery_attempts increments and delivery_status updates once it resolves.