List event types

Every event type, what it means, and whether webhooks can receive it.

Public, in catalog order and paginated like any list, so pass limit=100 for all of them at once. webhooks says whether an endpoint can subscribe to the type: account events, such as turning on two-step verification, belong to a person and are only listed. area groups types the way the dashboard does.

Query

limit integer

Page size, from 1 to 100. Defaults to 25.
cursor string

The next_cursor from the previous page. See pagination.

Errors

400 invalid_request

The cursor doesn't name an event type.

Any request can also fail on its key or its body. See errors.

Request

curl "https://api.402pay.co/api/v1/event-types?limit=100"

const response = await fetch("https://api.402pay.co/api/v1/event-types?limit=100");
const { data } = await response.json();

import requests

response = requests.get(
    "https://api.402pay.co/api/v1/event-types?limit=100",
)
data = response.json()["data"]

Response200 OK

{
  "data": [
    {
      "kind": "event_type",
      "type": "payment.succeeded",
      "title": "Payment succeeded",
      "description": "A payment was paid in full, or accepted, and its funds landed in the wallet.",
      "area": "Payments",
      "webhooks": true
    }
  ],
  "has_more": false,
  "next_cursor": null
}