---
title: "Poll webhook events"
method: GET
path: "/v0/webhook-events"
tags: ["Webhook Events"]
---

# Poll webhook events

`GET /v0/webhook-events`

## Request

- Base URL: `https://distributor-api.spiko.io`
- URL: `https://distributor-api.spiko.io/v0/webhook-events`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/spiko/apis/spiko-distributor-api/docs/v0/webhook-events/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve webhook events using cursor-based pagination. Pass the last `sequenceNumber` as `after` to get the next page.

## Query parameters

- `after` string
- `eventType` 'account.internal.created' | 'deposit-order.created' | 'deposit-order.funded' | 'deposit-order.executed' | 'deposit-order.canceled' | 'deposit-order.retargeted' | 'withdrawal-order.pending' | 'withdrawal-order.executed' | 'withdrawal-order.canceled' | 'transfer-order.created' | 'transfer-order.executed' | 'swap-order.created' | 'swap-order.executed' | 'swap-order.canceled' | 'investor.created' | 'investor.updated' | 'investor.activated' | 'investor.made-compliant' | 'investor.made-non-compliant' | 'investor.archived' | 'bank-account.created' | 'bank-account.validated' | 'bank-account.invalidated' | 'bank-account.pending-validation' | 'bank-account.archived' | 'investor-invitation.accepted' | 'yield.credited' | 'subscription-order.created' | 'subscription-order.executed' | 'subscription-order.canceled' | 'subscription-order.wire-validated' | 'redemption-order.created' | 'redemption-order.executed' | 'redemption-order.canceled'
- `limit` string

## Response `200`

Success

- union[]
  - union
    - object
      - `id` string, uuid, required: a Universally Unique Identifier
      - `sequenceNumber` number, required
      - `webhookConfigurationId` string, uuid, required: a Universally Unique Identifier
      - `distributorId` string, uuid, required: a Universally Unique Identifier
      - `eventType` 'account.internal.created' | 'deposit-order.created' | 'deposit-order.funded' | 'deposit-order.executed' | 'deposit-order.canceled' | 'deposit-order.retargeted' | 'withdrawal-order.pending' | 'withdrawal-order.executed' | 'withdrawal-order.canceled' | 'transfer-order.created' | 'transfer-order.executed' | 'swap-order.created' | 'swap-order.executed' | 'swap-order.canceled' | 'investor.created' | 'investor.updated' | 'investor.activated' | 'investor.made-compliant' | 'investor.made-non-compliant' | 'investor.archived' | 'bank-account.created' | 'bank-account.validated' | 'bank-account.invalidated' | 'bank-account.pending-validation' | 'bank-account.archived' | 'investor-invitation.accepted' | 'yield.credited' | 'subscription-order.created' | 'subscription-order.executed' | 'subscription-order.canceled' | 'subscription-order.wire-validated' | 'redemption-order.created' | 'redemption-order.executed' | 'redemption-order.canceled', required
      - `payload` unknown, required
      - `retryCount` integer, required
      - `createdAt` string, required: A valid date within the range 2020-2100
      - `status` 'pending', required
      - `httpStatusCode` integer, nullable, required
      - `lastAttemptAt` string, nullable, required: A valid date within the range 2020-2100
      - `deliveredAt` string, nullable, required: A valid date within the range 2020-2100
    - object
      - `id` string, uuid, required: a Universally Unique Identifier
      - `sequenceNumber` number, required
      - `webhookConfigurationId` string, uuid, required: a Universally Unique Identifier
      - `distributorId` string, uuid, required: a Universally Unique Identifier
      - `eventType` 'account.internal.created' | 'deposit-order.created' | 'deposit-order.funded' | 'deposit-order.executed' | 'deposit-order.canceled' | 'deposit-order.retargeted' | 'withdrawal-order.pending' | 'withdrawal-order.executed' | 'withdrawal-order.canceled' | 'transfer-order.created' | 'transfer-order.executed' | 'swap-order.created' | 'swap-order.executed' | 'swap-order.canceled' | 'investor.created' | 'investor.updated' | 'investor.activated' | 'investor.made-compliant' | 'investor.made-non-compliant' | 'investor.archived' | 'bank-account.created' | 'bank-account.validated' | 'bank-account.invalidated' | 'bank-account.pending-validation' | 'bank-account.archived' | 'investor-invitation.accepted' | 'yield.credited' | 'subscription-order.created' | 'subscription-order.executed' | 'subscription-order.canceled' | 'subscription-order.wire-validated' | 'redemption-order.created' | 'redemption-order.executed' | 'redemption-order.canceled', required
      - `payload` unknown, required
      - `retryCount` integer, required
      - `createdAt` string, required: A valid date within the range 2020-2100
      - `status` 'delivered', required
      - `httpStatusCode` integer, required
      - `lastAttemptAt` string, required: A valid date within the range 2020-2100
      - `deliveredAt` string, required: A valid date within the range 2020-2100
    - object
      - `id` string, uuid, required: a Universally Unique Identifier
      - `sequenceNumber` number, required
      - `webhookConfigurationId` string, uuid, required: a Universally Unique Identifier
      - `distributorId` string, uuid, required: a Universally Unique Identifier
      - `eventType` 'account.internal.created' | 'deposit-order.created' | 'deposit-order.funded' | 'deposit-order.executed' | 'deposit-order.canceled' | 'deposit-order.retargeted' | 'withdrawal-order.pending' | 'withdrawal-order.executed' | 'withdrawal-order.canceled' | 'transfer-order.created' | 'transfer-order.executed' | 'swap-order.created' | 'swap-order.executed' | 'swap-order.canceled' | 'investor.created' | 'investor.updated' | 'investor.activated' | 'investor.made-compliant' | 'investor.made-non-compliant' | 'investor.archived' | 'bank-account.created' | 'bank-account.validated' | 'bank-account.invalidated' | 'bank-account.pending-validation' | 'bank-account.archived' | 'investor-invitation.accepted' | 'yield.credited' | 'subscription-order.created' | 'subscription-order.executed' | 'subscription-order.canceled' | 'subscription-order.wire-validated' | 'redemption-order.created' | 'redemption-order.executed' | 'redemption-order.canceled', required
      - `payload` unknown, required
      - `retryCount` integer, required
      - `createdAt` string, required: A valid date within the range 2020-2100
      - `status` 'failed', required
      - `httpStatusCode` integer, nullable, required
      - `lastAttemptAt` string, nullable, required: A valid date within the range 2020-2100
      - `deliveredAt` string, nullable, required: A valid date within the range 2020-2100
      - `failureReason` 'configuration-circuit-broken' | 'configuration-disabled' | 'delivery-attempts-exhausted' | 'permanent-failure' | 'retry-scheduling-failed', nullable, required: Why the event was not delivered. `configuration-circuit-broken` and `configuration-disabled` mean no delivery was attempted because the webhook configuration was not active at the time; `retryCount` stays `0` and `lastAttemptAt` is `null` for those.

## Other responses

- `400`: The request did not match the expected schema
- `401`: Authentication failed. Two bodies are possible: the schema below when the API rejects the credentials, and `{ "error": { "code", "status", "request", "message" } }` when the API gateway rejects them first. Only the former carries a `_tag`.
- `403`: Forbidden
- `503`: The investor is undergoing a scheduled upgrade, access is temporarily paused to ensure data safety.

---

[API](https://skmtc.dev/spiko/apis/spiko-distributor-api.md) - [All operations](https://skmtc.dev/spiko/apis/spiko-distributor-api/llms.txt) - [OpenAPI document](https://skmtc.dev/spiko/apis/spiko-distributor-api/revisions/ad85137fd00b?raw)