List custom events

Pre-release

GET

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

GET

/api/v1/event/custom/configuration

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

200Available Custom Events

1 [
2   {
3     "organisation": {
4       "id": 200
5     },
6     "template": {
7       "id": 1
8     },
9     "configuration_properties": [
10       {
11         "property": "count_of_pdp",
12         "value": "10",
13         "value_array": [
14           "string"
15         ]
16       },
17       {
18         "property": "duration",
19         "value": "1w",
20         "value_array": [
21           "string"
22         ]
23       }
24     ],
25     "name": "PDP Threshold 50 Over One Week",
26     "id": "2",
27     "supportedTargetingParameters": [
28       "string"
29     ],
30     "supportedActions": [
31       "string"
32     ],
33     "supported_targeting_parameters": [
34       {
35         "parameter": "service_policy",
36         "type": "number[]",
37         "description": "Service Policy"
38       },
39       {
40         "parameter": "endpoint_tag",
41         "type": "string[]",
42         "description": "Endpoint Tag"
43       }
44     ],
45     "supported_actions": [
46       {
47         "id": "system-send_notification_with_email",
48         "status": "active",
49         "type": "system",
50         "configuration_properties": [
51           {
52             "property": "recipients",
53             "type": "email[]",
54             "default": null,
55             "required": true,
56             "description": "List of email addresses to notify"
57           }
58         ],
59         "name": "Send notification via email",
60         "description": "Send notification via email",
61         "translation_key_name": "Send notification with email N",
62         "translation_key_description": "Send notification with email D",
63         "required_event_output_parameters": [
64           {
65             "parameter": "event_description",
66             "type": "string",
67             "description": "Standard description of the event"
68           }
69         ]
70       }
71     ]
72   }
73 ]

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

List custom events

List custom events

Authentication

Response

Authentication

Response

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

1	[
2	{
3	"organisation": {
4	"id": 200
5	},
6	"template": {
7	"id": 1
8	},
9	"configuration_properties": [
10	{
11	"property": "count_of_pdp",
12	"value": "10",
13	"value_array": [
14	"string"
15	]
16	},
17	{
18	"property": "duration",
19	"value": "1w",
20	"value_array": [
21	"string"
22	]
23	}
24	],
25	"name": "PDP Threshold 50 Over One Week",
26	"id": "2",
27	"supportedTargetingParameters": [
28	"string"
29	],
30	"supportedActions": [
31	"string"
32	],
33	"supported_targeting_parameters": [
34	{
35	"parameter": "service_policy",
36	"type": "number[]",
37	"description": "Service Policy"
38	},
39	{
40	"parameter": "endpoint_tag",
41	"type": "string[]",
42	"description": "Endpoint Tag"
43	}
44	],
45	"supported_actions": [
46	{
47	"id": "system-send_notification_with_email",
48	"status": "active",
49	"type": "system",
50	"configuration_properties": [
51	{
52	"property": "recipients",
53	"type": "email[]",
54	"default": null,
55	"required": true,
56	"description": "List of email addresses to notify"
57	}
58	],
59	"name": "Send notification via email",
60	"description": "Send notification via email",
61	"translation_key_name": "Send notification with email N",
62	"translation_key_description": "Send notification with email D",
63	"required_event_output_parameters": [
64	{
65	"parameter": "event_description",
66	"type": "string",
67	"description": "Standard description of the event"
68	}
69	]
70	}
71	]
72	}
73	]