systemEvents

Get a system event by ID

Retrieves a specific system event and its supported targeting options. Each event declares which actions are offered for it in supported_action_ids. When the field is absent, the event declares no restriction and every parameter-compatible action is offered; an empty array declares that no actions are offered.

get/api/v1/event/system/configuration/{system_event_id}

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/event/system/configuration/{system_event_id}
  • Auth: HTTP bearer

Path parameters

system_event_idstring required

Response

idstring required
namestring required
translationKeyNamestring required
descriptionstring required
translationKeyDescriptionstring required
supportedTargetingParametersstring[] required
supportedActionsstring[] required
supported_action_idsstring[]

Action IDs this event declares support for, used to decide which actions are offered for it.

  • Field absent: no restriction is declared, so every action whose required_event_output_parameters the event emits is offered.
  • Empty array: a declaration in its own right, so no actions are offered.
  • Non-empty list: intersected with the parameter check, so a listed action is offered only if the event also emits every parameter that action requires.

The list can only narrow what's offered, never widen it.

Changes

No recorded changes to this operation across all 1 revision of this API.