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

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

Returns a list of all available system events and their supported targeting options.

List system events

List system events

Authentication

Response

Authentication

Response

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

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