List Automation Events

Lists the custom automation events your workspace has defined.

GEThttps://api.audienceful.com/v2/automations/events

curl --location --request GET 'https://api.audienceful.com/v2/automations/events' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <your-api-key>'

{
  "data": [
    {
      "id": "aB3xY7dKvQk6HNNtduqrX9",
      "name": "signed_up",
      "triggered_count": 42,
      "properties": [
        { "name": "plan", "type": "string", "required": false }
      ],
      "created_at": "2026-07-04T12:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Requires the events:read scope. These are the named triggers a workspace defines (e.g. signed_up, purchased) — the events you can fire with Trigger Event, along with the payload properties each one declares. Results are cursor-paginated and ordered by name.

Query parameters

page_sizenumberdefault: 100

The number of events to return per page.

cursorstring

The pagination cursor from a previous response's next_cursor. See Pagination.

Response

dataarray

The page of custom event definitions.

Properties

idstring

The event's unique id.

namestring

The event name you pass when triggering it.

triggered_countnumber

How many times this event has been triggered.

propertiesarray

The payload properties this event declares.

Properties

namestring

The property name.

typestring

The property's data type.

requiredboolean

Whether the property is required when triggering the event.

created_atstring

The datetime (UTC) the event was created.

has_moreboolean

Whether more events exist after this page.

next_cursorstring or null

The cursor to pass as ?cursor= to fetch the next page.