​
Prerequisites

  • Have a Heex CLI
  • Have a USER_SECRET_KEY. Should be accessible in your personnal space on the heex cloud platform.

​
Usage

SubcommandDescription
getRetrieve info on generated events available on the cloud, can be filtered by specifying custom keys.
Usage: 
./heex events SUBCOMMAND [--help]

​
How to get event infos

This command allows you to retrieve events based on system/trigger IDs and other optional filters, or by event ID. Note that all filters are optional, if no filters are provided, it will return all events found on page 1. Available options:
  • --api-key: mandatory USER_SECRET_KEY.
  • --system-id: The ID of the system to retrieve the events from.
  • --trigger-id: The ID of the trigger to retrieve the events from.
  • --limit: The maximum number of events to retrieve.
  • --page: Page number to look into for events. Default is page 1.
  • --start-time: Start timestamp for event filtering, in seconds since the Unix epoch.
  • --end-time: End timestamp for event filtering, in seconds since the Unix epoch.
  • --event-id: The ID of a specific event to retrieve. Multiple IDs can be specified, example : --event-id ID1 --event-id ID2.
  • --output-file: If set, it’ll provide the result in a json format in a file generated at given path. Make sure you provide the ‘.json’ extension.
Usage: 
./heex events get --api-key <USER_SECRET_KEY> --system-id <SYSTEM_ID> --output-file allEventsForThisSystem.json

​
Getting Help

./heex events --help
./heex events get --help