> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.thepennyinc.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.thepennyinc.com/_mcp/server.

# List webhook events

GET https://sandbox.api.thepennyinc.com/notifications/webhooks/events

List business notification events, optionally filtered to a single event identifier. Without an identifier, all events for the business are returned ordered by occurrence.

Required permissions: `notification_event:list`.

Reference: https://docs.thepennyinc.com/banking/api-reference/platform/notifications/webhooks/events/list

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://sandbox.api.thepennyinc.com` (Sandbox — safe for testing, no real money movement., default)
- `https://live.api.thepennyinc.com` (Live — real businesses, real money movement.)

## Request

### Query parameters

- `identifier` (enum, optional, nullable) — Event identifier to filter by. Omit to list all events.
  - Allowed values: `business.created`, `business.updated`, `business_entity.created`, `business_entity.updated`, `business_entity.kyb.approved`, `business_entity.kyb.declined`, `user.created`, `user.updated`, `account.created`, `account.updated`, `account.deletion.initialized`, `account.deletion.completed`, `account.low_balance_alert`, `linked_account.created`, `linked_account.updated`, `cardholder.created`, `cardholder.updated`, `cardholder.deletion.initialized`, `cardholder.deletion.completed`, `card.issued`, `card.updated`, `card.terminated`, `card_product.created`, `card_product.updated`, `spend_control.created`, `spend_control.updated`, `spend_control.deleted`, `transaction.created`, `transaction.updated`, `ledger_entry.created`, `fee.created`, `fee.updated`, `task.created`, `task.updated`
- `page_size` (integer, optional, default: 100) — Maximum number of results to return per page. Defaults to 100.
- `next_page_token` (string, optional, nullable) — Pagination key used to retrieve the next page of results.

### Headers

- `X-Penny-As-Business` (string, optional, nullable) — Act on behalf of another business that has granted you access. Requires the `business:act_as` permission.

## Response

### 200

A list of webhook events.

- `items` (list of NotificationEvent, required) — The list of items returned by the API.
- `count` (integer, required) — The total number of items returned in this response.
- `next_page_token` (string, optional, nullable) — A token for retrieving the next page of results, if applicable.

## Errors

### 400 Bad Request Error

The request was malformed: a required field is missing or a value has the wrong type or format.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 401 Unauthorized Error

Authentication failed.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 403 Forbidden Error

The caller does not have permission to perform this action.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 422 Unprocessable Entity Error

The request was well-formed but could not be processed because it breaks a business rule.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 429 Too Many Requests Error

Too many requests; retry after the Retry-After header.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 500 Internal Server Error

An unexpected error occurred.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

## Types

### NotificationEvent

A notification event, as shown to clients when listing events. Describes what happened. What became of telling any given endpoint is a separate resource — see `NotificationDeliveryClientAPIResponse` — because a single event may have been delivered to several endpoints with different outcomes, and folding them together would mean reporting one arbitrarily. Deliberately trimmed relative to a single-event lookup: no payload content. See `NotificationEventDetailClientAPIResponse` for that.

- `notification_event_id` (string, required) — Penny's unique identifier for this event.
- `version` (integer, required) — A number that increases each time this event's record changes. Use it to confirm you are looking at the latest information.
- `version_time` (datetime, required) — The date and time this event's record was last changed.
- `business_id` (string, required) — The business this event belongs to.
- `type` (string, required) — The notification event type. This identifies the specific occurrence represented by the event.
- `category` (enum, required) — The category of content carried by this event, such as an object change, alert, or message.
  - Allowed values: `object`, `alert`, `message`, `verification`
- `event_time` (datetime, required) — When this event was generated.
- `occurrence_time` (datetime, required) — When the underlying occurrence took place.
- `source_business_id` (string, optional, nullable) — The business this event originated from, if different from the receiving business.

## Examples

**Response**

```json
{
  "items": [
    {
      "notification_event_id": "notification_event_01937a7a-af1b-7ced-842f-af1bced42f42",
      "version": 1,
      "version_time": "2024-01-15T10:30:00Z",
      "business_id": "business_01937b95-484e-75af-8c68-484e5afc68d3",
      "type": "transaction.updated",
      "category": "object",
      "event_time": "2024-01-15T10:30:00Z",
      "occurrence_time": "2024-01-15T10:30:00Z",
      "source_business_id": "string"
    }
  ],
  "count": 1,
  "next_page_token": "string"
}
```

**SDK Code**

```python
import requests

url = "https://sandbox.api.thepennyinc.com/notifications/webhooks/events"

headers = {
    "X-Penny-As-Business": "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://sandbox.api.thepennyinc.com/notifications/webhooks/events';
const options = {
  method: 'GET',
  headers: {
    'X-Penny-As-Business': 'business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.api.thepennyinc.com/notifications/webhooks/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Penny-As-Business", "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://sandbox.api.thepennyinc.com/notifications/webhooks/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Penny-As-Business"] = 'business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://sandbox.api.thepennyinc.com/notifications/webhooks/events")
  .header("X-Penny-As-Business", "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://sandbox.api.thepennyinc.com/notifications/webhooks/events', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Penny-As-Business' => 'business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://sandbox.api.thepennyinc.com/notifications/webhooks/events");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Penny-As-Business", "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Penny-As-Business": "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox.api.thepennyinc.com/notifications/webhooks/events")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```