---
title: "Get webhook events"
method: GET
path: "/webhook-events"
tags: ["Webhooks"]
---

# Get webhook events

`GET /webhook-events`

> ⚠️
>
> **Authentication**
> This endpoint requires [app-scoped](/reference/api-akahu-io-authentication#app-scoped-endpoints) authentication.

Returns a list of webhook events that have been published to your application by Akahu within the `start` and `end` time range.

>️ ℹ️ Time range defaults to the last 30 days.

For more details about webhooks see:
  - [📖 Webhooks reference](/docs/reference-webhooks)
  - [📖 Webhooks events](/reference-webhooks#token)

## Query parameters

- `status` 'SENT' | 'FAILED' | 'RETRY'
- `start` string, date-time
- `end` string, date-time

## Headers

- `X-Akahu-Id` string, required

## Response `200`

Successful response.

- object
  - `success` boolean
  - `items` WebhookEvent[]
    - `_id` string — Unique Akahu webhook event identifier.
    - `hook` string — Unique Akahu webhook identifier.
    - `status` 'SENT' | 'RETRY' | 'FAILED' — Webhook event state - `SENT` Webhook has been sent and has been confirmed with a `200` response from the receiver. - `RETRY` Webhook has failed to send in a previous attempt but it will be retried. - `FAILED` Webhook has failed to send after attempted retries, due to not receiving a `200` response from the receiver.
    - `created_at` string, date-time — ISO 8601 formatted timestamp that the webhook event was created.
    - `updated_at` string, date-time — ISO 8601 formatted timestamp that the webhook event was last updated.
    - `last_failed_at` string, date-time — ISO 8601 formatted timestamp that the webhook event last failed.
    - `payload` object — payload / event body sent to the `_hook`
      - `success` boolean
      - `webhook_type` 'TOKEN' | 'ACCOUNT' | 'TRANSACTION' | 'PAYMENT' | 'TRANSFER' — Resource the webhook event is related to for more details checkout the [📖 Webhooks reference](/docs/reference-webhooks)
      - `webhook_code` string — Webhook action dependant on the `webhook_type` for more details on our provided webhooks checkout the [📖 Webhooks reference](/docs/reference-webhooks)

## Other responses

- `400` — Your request was malformed or otherwise unacceptable. More details are provided under the `message` key in the response.
- `401` — You are not authorised to access this content.
- `403` — You are not allowed to access this content.
- `500` — An internal error has prevented us from processing the request. More detail may be supplied in the `message` key.

---

[API](https://skmtc.dev/akahu/apis/akahu-enduring-api.md) · [All operations](https://skmtc.dev/akahu/apis/akahu-enduring-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/akahu/akahu-enduring-api/revisions/b2de9915920d/schema)