getAllEvents

Get all available events.

Description

This method returns all events available in the project. It returns a Promise that resolves to an array of IContentApiEvent objects.

Events.getAllEvents(

);

Examples

Minimal example

const response = await Events.getAllEvents();

Example response

[
  {
    "id": 1,
    "identifier": "price_change",
    "localizeInfos": {
      "title": "Price change"
    },
    "module": "catalog"
  }
]

Response schema

Schema: IContentApiEvent[]

[]: IContentApiEvent
A single available event.

[].id: number
Event identifier.
example: 1

[].identifier: string
Event text identifier.
example: "price_change"

[].localizeInfos: Record<string, unknown>
Localized info of the event.
example: { "title": "Price change" }

[].module: string
Module the event belongs to.
example: "catalog"

---