Get a system event by ID | emnify Documentation

import requests
url = "https://cdn.emnify.net/api/v1/event/system/configuration/system_event_id"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

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

Retrieves a specific system event and its supported targeting options.

Authentication

AuthorizationBearer

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

Path parameters

system_event_idstringRequired

Response

idstring

parentOrgobject

eventTypeobject

namestring

translationKeyNamestring

descriptionstring

translationKeyDescriptionstring

supportedTargetingParameterslist of strings

eventOutputParameterslist of objects

supportedActionslist of strings

1	{
2	"id": "605",
3	"parentOrg": {
4	"id": 2
5	},
6	"eventType": {
7	"id": 65
8	},
9	"name": "Endpoint data traffic limit warning",
10	"translationKeyName": "endpoint_data_traffic_limit_warning_n",
11	"description": "Endpoint data traffic limit warning",
12	"translationKeyDescription": "endpoint_data_traffic_limit_warning_d",
13	"supportedTargetingParameters": [
14	{
15	"parameter": "service_policy",
16	"type": "number[]",
17	"description": "Service Policy"
18	},
19	{
20	"parameter": "endpoint_tag",
21	"type": "string[]",
22	"description": "Endpoint Tag",
23	"validators": [
24	{
25	"type": "minCount",
26	"value": 1
27	}
28	]
29	}
30	],
31	"eventOutputParameters": [
32	{
33	"parameter": "event_description",
34	"type": "string",
35	"description": "Standard description of the event"
36	}
37	],
38	"supportedActions": [
39	{
40	"id": "system-send_notification_with_email",
41	"status": "active",
42	"type": "system",
43	"configuration_properties": [
44	{
45	"property": "recipients",
46	"type": "email[]",
47	"default": null,
48	"required": true,
49	"description": "List of email addresses to notify"
50	}
51	],
52	"name": "Send notification via email",
53	"description": "Send notification via email",
54	"translation_key_name": "Send notification with email N",
55	"translation_key_description": "Send notification with email D",
56	"required_event_output_parameters": [
57	{
58	"parameter": "event_description",
59	"type": "string",
60	"description": "Standard description of the event"
61	}
62	]
63	}
64	]
65	}