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": "605",
    "parentOrg": {
      "id": 1.1
    },
    "eventType": {
      "id": 1.1
    },
    "name": "Endpoint data traffic limit warning",
    "translationKeyName": "string",
    "description": "Endpoint data traffic limit warning",
    "translationKeyDescription": "string",
    "supportedTargetingParameters": [
      "string"
    ],
    "eventOutputParameters": [
      {
        "parameter": "string",
        "type": "string",
        "description": "string"
      }
    ],
    "supportedActions": [
      "string"
    ],
    "supported_action_ids": [
      "system-send_notification_with_email"
    ],
    "event_type": {
      "id": 65
    },
    "parent_organisation": {
      "id": 2
    },
    "supported_actions": [
      {
        "configuration_properties": [
          {
            "default": null,
            "description": "List of email addresses to notify",
            "property": "recipients",
            "required": true,
            "type": "email[]"
          }
        ],
        "description": "Send notification via email",
        "id": "system-send_notification_with_email",
        "name": "Send notification via email",
        "required_event_output_parameters": [
          {
            "description": "Standard description of the event",
            "parameter": "event_description",
            "type": "string"
          }
        ],
        "status": "active",
        "translation_key_description": "Send notification with email D",
        "translation_key_name": "Send notification with email N",
        "type": "system"
      }
    ],
    "supported_targeting_parameters": [
      {
        "description": "Service Policy",
        "parameter": "service_policy",
        "type": "number[]"
      },
      {
        "description": "Endpoint Tag",
        "parameter": "endpoint_tag",
        "type": "string[]",
        "validators": [
          {
            "type": "minCount",
            "value": 1
          }
        ]
      }
    ],
    "translation_key_description": "endpoint_data_traffic_limit_warning_d",
    "translation_key_name": "endpoint_data_traffic_limit_warning_n"
  }
]

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.

Authentication

AuthorizationBearer

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

Response

idstring

parentOrgobject

eventTypeobject

namestring

translationKeyNamestring

descriptionstring

translationKeyDescriptionstring

supportedTargetingParameterslist of strings

eventOutputParameterslist of objects

supportedActionslist of strings

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.