List upcoming (queued) events

curl --request GET \
  --url https://api.paystack.com/v1/notifications/webhooks/{id}/events \
  --header 'Authorization: Bearer <token>'

{
  "status": true,
  "message": "Upcoming events retrieved",
  "code": "ok",
  "data": [
    {
      "event_idempotency_key": "evt-1",
      "topic": "onramp.success",
      "attempts": 2,
      "created_at": "2026-05-26T12:00:00.000Z",
      "payload": {
        "amount": 100,
        "currency": "NGN"
      },
      "last_attempt_at": "2026-05-26T12:00:05.000Z"
    }
  ],
  "meta": {
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

Notification Webhooks

List upcoming (queued) events

Returns the events currently queued for delivery to a webhook endpoint (pending, not yet delivered), oldest first. Each entry identifies the event by its event_idempotency_key and topic, how many delivery attempts have been made so far, when the last attempt ran, and the payload that will be delivered.

Use this to see what is in flight for an endpoint — for example after reactivating a paused endpoint or while investigating a delivery backlog.

Example

GET /v1/notifications/webhooks/whr_01HXYZABC1234567890ABCDEFG/events

GET

notifications

webhooks

{id}

events

List upcoming (queued) events

curl --request GET \
  --url https://api.paystack.com/v1/notifications/webhooks/{id}/events \
  --header 'Authorization: Bearer <token>'

{
  "status": true,
  "message": "Upcoming events retrieved",
  "code": "ok",
  "data": [
    {
      "event_idempotency_key": "evt-1",
      "topic": "onramp.success",
      "attempts": 2,
      "created_at": "2026-05-26T12:00:00.000Z",
      "payload": {
        "amount": 100,
        "currency": "NGN"
      },
      "last_attempt_at": "2026-05-26T12:00:05.000Z"
    }
  ],
  "meta": {
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

Authorizations

Authorization

string

header

required

API key issued during merchant onboarding.

Path Parameters

string

required

Pattern: [^\/#\?]+?

Response

Upcoming events retrieved

status

enum<boolean>

required

Available options:

true

Example:

true

message

string

required

Human-readable summary

Example:

"Upcoming events retrieved"

code

enum<string>

required

Available options:

ok

Example:

"ok"

data

object[]

required

Show child attributes