Skip to main content

​
Prerequisites

  • Have a Heex CLI
  • Have an API_KEY. Should be accessible in your personnal space on the heex cloud platform. If you already logged-in you don’t need to add the Api-Key in your command line.

​
Usage

SubcommandDescription
getRetrieve event with a given ID.
listRetrieve info on generated events available on the cloud, can be filtered by specifying custom keys.
deleteDelete an event with a given ID.
Usage: 
./heex events SUBCOMMAND [--help]

​
How to get list of event with details

This command allows you to retrieve events based on system, trigger IDs or by event ID. Note that all filters are optional, if no filters are provided, it will return all events found. Available options:
  • --api-key: Add your API_KEY which can be found on the cloud [required]. No need to provide if you have an active userconfig.
  • --system-id: The ID of the system to retrieve the events from.
  • --trigger-id: The ID of the trigger to retrieve the events from.
  • --event-id: The ID of a specific event to retrieve. Multiple IDs can be specified, example : --event-id ID1 --event-id ID2.
  • --output-file: The result will be saved into this provided filepath. The output format is json, so please provide a filepath with that format: /path/to/file.json
  • --json-output: Disables all logging (except errors), and your command shall only output the result in a json format. Not compatible with ‘—output-file’ option.
Usage: 
./heex events list --system-id <SYSTEM_ID> --output-file allEventsForThisSystem.json

​
How to get a specific event

This command allows you to retrieve an event with a given ID. Note that the event ID is mandatory. You can save output in a json file by using the --output-file option. Available options:
  • --api-key: Add your user API_KEY which can be found on the cloud [required]. No need to provide if you have an active userconfig.
  • --event-id: ID of the involved event [required].
  • --output-file: The result will be saved into this provided filepath. The output format is json, so please provide a filepath with that format: /path/to/file.json
  • --json-output: Disables all logging (except errors), and your command shall only output the result in a json format. Not compatible with ‘—output-file’ option.
Usage: 
./heex events get --event-id <EVENT_ID> --output-file EventDetailsID.json

​
How to delete events

To delete events, you can specify what list of events you want to delete. If you use the command without any option, you delete ALL events on your workspace, so use with care (note that there is a confirmation message before deleting as a safety measure). Following options show what you can do to specify what events you want to delete: Available options:
  • --api-key: Add your user API_KEY which can be found on the cloud [required]. No need to provide if you have an active userconfig.
  • --event-id: Filter on specific event IDs. Multiple can be given: —event-id ID1 —event-id ID2 …etc
  • --system-id: Filter on a specific system ID. All events associated to this system will be deleted.
  • --trigger-id: Filter on a specific trigger ID. All events associated to this trigger will be deleted.
  • --input-file: You may provide the output file of the events list command, it’ll delete all events listed in the file. If you provide this option, you don’t need to provide any other options.
  • --auto-approve: If you delete more than 1 event, a confirmation prompt is added. Set this flag to automatically approve the prompt and delete all events without confirmation.
Usage: 
./heex events delete --event-id <EVENT_ID1> --event-id <EVENT_ID2> --system-id <SYSTEM_ID>

​
Getting Help

./heex events --help
./heex events get --help
./heex events list --help
./heex events delete --help