List system events

Pre-release

GET

https://cdn.emnify.net/api/v1/event/system/configuration

GET

/api/v1/event/system/configuration

curl https://cdn.emnify.net/api/v1/event/system/configuration \
     -H "Authorization: Bearer <token>"

200System Events

[
  {
    "id": "0b721b5e-4208-47fd-8a16-b24ceebb28be",
    "parent_organisation": {
      "id": 2
    },
    "event_type": {
      "id": 65
    },
    "name": "Endpoint data traffic limit warning",
    "translation_key_name": "endpoint_data_traffic_limit_warning_n",
    "description": "Endpoint data traffic limit warning",
    "translation_key_description": "endpoint_data_traffic_limit_warning_d",
    "supported_targeting_parameters": [
      {
        "parameter": "service_policy",
        "type": "number[]",
        "description": "Service Policy"
      },
      {
        "parameter": "endpoint_tag",
        "type": "string[]",
        "description": "Endpoint Tag",
        "validators": [
          {
            "validator_type": "minCount",
            "validator_value": "1"
          }
        ]
      }
    ],
    "event_output_parameters": [
      {
        "parameter": "description",
        "type": "string",
        "description": "Description of the event"
      },
      {
        "parameter": "endpoint_id",
        "type": "number",
        "description": "Endpoint id"
      }
    ],
    "supported_action_ids": [
      "system-send_notification_with_email"
    ]
  }
]

Returns a list of all available system events and their 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, apart from the email notification action. To get the full action objects, call GET /api/v1/automation/action and filter them as its description explains.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

idstring

parent_organisationobject

event_typeobject

namestring

translation_key_namestring

descriptionstring

translation_key_descriptionstring

supported_targeting_parameterslist of objects

event_output_parameterslist of objects

supported_action_idslist of stringsOptional

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.

The email notification action, system-send_notification_with_email, is exempt from this list, but the event must still emit the parameters it requires.