List catalog event types

Returns the full, fixed catalog of webhook event names your integration can subscribe to (the same 22-name WebhookEventName enum accepted by enabled_events), each with a one-line description of when it fires. Not paginated - the catalog is small and changes only alongside a versioned API bump, never per-request. Scope: webhooks:read.

GET /v1/webhook_endpoints/event_types

List catalog event types

cURL

curl --request GET \
  --url https://api.vexioncards.one/v1/webhook_endpoints/event_types \
  --header 'Authorization: Bearer <token>'

200

{
  "object": "list",
  "data": [
    {
      "name": "customer.created",
      "description": "A customer enrolls on one of your loyalty cards."
    },
    {
      "name": "transaction.created",
      "description": "A stamp, points, cashback, discount or coupon redeem transaction is recorded. The transaction carries `team_member_id` when a team member booked it, and the `products` of the bill. Gift card and membership entries are listed by GET /v1/transactions but send no event."
    }
  ],
  "has_more": false,
  "url": "/v1/webhook_endpoints/event_types"
}

Authorizations

Authorization · string · header · required

Your secret API key as a Bearer token: Authorization: Bearer vxn_sk_.... Keys are created and scoped in the dashboard - see Authentication.

Response

200

application/json

The full event catalog.

Standard cursor-pagination envelope for list endpoints. See the Pagination guide.

object · string · required

Always "list".

Allowed value: "list"

data · object[] · required

Array of the requested resource type.

Show child attributes

has_more · boolean · required

True when more pages exist - pass the last item id as starting_after.

next_cursor · string | null

Cursor for the next page in the direction you are already paging, or null when this page ends the collection. has_more: true always comes with a non-null next_cursor.

Feed it back to the SAME parameter you used: starting_after when paging forward (the default), or ending_before when paging backward. Treat it as opaque and do not parse it.

You no longer need to take the last object's id yourself. That still works and is unchanged, but deriving the cursor from the page put the burden of knowing the sort direction on you, and it broke silently on any endpoint whose cursor is not the object id.

Example:

"cus_iofv5j4hn6bphinmmyat27tc5y"

url · string

Stable collection URL.