List Notification Deliveries

GET /notification_deliveries

List Notification Deliveries

Read the delivery log for the organization's notification channels, newest first — what was sent, to which channel, and whether it landed.

Paginate with the cursor rather than an offset: pass the next_before_id from the previous response as before_id. A response whose next_before_id is null is the last page.

payload is the event body as it was handed to the channel, and last_error carries the delivery failure verbatim.

Parameters

• channel_id (query, string, optional): Restrict to deliveries to one notification channel.

• status (query, string, optional): Restrict by delivery state. pending is still queued for retry; failed has exhausted its attempts.

• before_id (query, integer, optional): Cursor: return deliveries older than this id. Use the next_before_id from the previous page.

• limit (query, integer, optional): Page size.

Responses

• 200: OK

• data (array, required):

• data[].id (integer, required): Delivery id, and the cursor value for before_id.

• data[].channel_id (string, required):

• data[].channel_name (string, required): Channel name at read time. null when the channel has since been deleted.

• data[].channel_type (string, required): Channel type at read time. null when the channel has since been deleted.

• data[].event_type (string, required): Event that triggered the delivery, e.g. a budget threshold.

• data[].payload (object, required): Event body as it was handed to the channel.

• data[].status (string, required): pending is still queued for retry; failed has exhausted its attempts.

• data[].attempts (integer, required): Delivery attempts made so far.

• data[].last_error (string, required): Verbatim failure from the most recent attempt.

• data[].next_attempt_at (string, required): When the next retry is due.

• data[].delivered_at (string, required): When the delivery succeeded. null until it does.

• data[].created_at (string, required):

• next_before_id (integer, required): Cursor for the next page. null when this is the last page.

• 400: Request body or parameters failed validation.

• error (object, required): Error details.

• error.code (string, required): Machine-readable identifier. Examples: UNAUTHENTICATED, INVALID_REQUEST, MASTER_KEY_UNSET, INTERNAL.

• error.message (string, required): Human-readable explanation; safe to surface to operators.

• 401: Missing or invalid bearer. Response fields (application/json): identical to GET /notification_deliveries, response 400 above.

cURL

curl -X GET '$AISIX_CP/notification_deliveries' -H 'Authorization: Bearer $AISIX_TOKEN'