Webhooks

List webhook deliveries

The delivery record for every event we tried to send you, newest first, including the ones that gave up. Delivery is attempted immediately, then after 5min, 30min, 2h and 12h; after the fifth failure the status is dead and it will NOT be retried.

Filter with status=dead to find events you never received. dead_count and in_flight_count are account-wide, not page-local, so they answer "is anything of mine lost right now" rather than "on this page".

A dead delivery is not the end: replay it with POST /api/v1/webhook-deliveries/{id}/redeliver.

Required scope: webhooks:manage.

get/api/v1/webhook-deliveries

Request

  • Base URL: https://arcnautical.com
  • URL: https://arcnautical.com/api/v1/webhook-deliveries
  • Auth: one of:
    • HTTP bearer
    • API key in header X-ArcNautical-Key

Query parameters

limitinteger

Rows per page, 1-200. Default 50.

cursorstring

next_cursor from the previous page, unmodified.

status'pending' | 'retry' | 'sending' | 'delivered' | 'dead'

Delivery state. Use dead for events that gave up after every retry.

event_typestring

One event type, for example vessel_risk.changed.

endpoint_idstring uuid

Only deliveries to this endpoint.

created_afterstring date-time

ISO 8601 lower bound, inclusive.

created_beforestring date-time

ISO 8601 upper bound, inclusive.

Response

Successful response.

next_cursorstring nullable
has_moreboolean required
dead_countinteger required

Account-wide, not page-local: how many events gave up entirely.

in_flight_countinteger required

Account-wide: how many are still queued or retrying.

retry_schedulestring

Changes

No recorded changes to this operation across all 1 revision of this API.