Create an automation

Pre-release

POST

https://cdn.emnify.net/api/v1/automation

POST

/api/v1/automation

$ curl -X POST https://cdn.emnify.net/api/v1/automation \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Send email notification for custom event",
>   "description": "Sends a notification via Email for custom event.\n",
>   "status": "active",
>   "actionable_event": {
>     "custom_event": {
>       "id": "2"
>     },
>     "system_event": {
>       "id": "string"
>     }
>   },
>   "configured_actions": [
>     {
>       "action": {
>         "id": "system-send_notification_with_email"
>       },
>       "properties": [
>         {
>           "property": "recipients",
>           "value": "string",
>           "value_array": [
>             "foo@bar.emnify"
>           ]
>         }
>       ]
>     }
>   ],
>   "targeting_properties": [
>     {
>       "property": "service_policy",
>       "value": "string",
>       "value_array": [
>         "2"
>       ]
>     }
>   ]
> }'

201Custom Event

1 {
2   "id": "56",
3   "name": "Endpoint data traffic limit warning email",
4   "description": "Sends an email when the endpoint data traffic limit warning is triggered for service profile 3.\n",
5   "status": "active",
6   "organisation": {
7     "id": 1550
8   },
9   "number_of_executions": 3,
10   "last_execution": "2025-01-01T00:00:00.000Z",
11   "created_at": "2024-01-01T03:00:00.000Z",
12   "modified_at": "2024-05-06T05:00:00.000Z",
13   "actionable_event": {
14     "custom_event": {
15       "organisation": {
16         "id": 1.1
17       },
18       "template": {
19         "id": 1.1
20       },
21       "configuration_properties": [
22         {
23           "property": "string",
24           "value": "string",
25           "value_array": [
26             "string"
27           ]
28         }
29       ],
30       "name": "string",
31       "id": "string",
32       "supportedTargetingParameters": [
33         "string"
34       ],
35       "supportedActions": [
36         "string"
37       ]
38     },
39     "system_event": {
40       "id": "605",
41       "parentOrg": {
42         "id": 1.1
43       },
44       "eventType": {
45         "id": 1.1
46       },
47       "name": "Endpoint data traffic limit warning",
48       "translationKeyName": "string",
49       "description": "Endpoint data traffic limit warning",
50       "translationKeyDescription": "string",
51       "supportedTargetingParameters": [
52         "string"
53       ],
54       "eventOutputParameters": [
55         {
56           "parameter": "string",
57           "type": "string",
58           "description": "string"
59         }
60       ],
61       "supportedActions": [
62         "string"
63       ],
64       "parent_organisation": {
65         "id": 2
66       },
67       "event_type": {
68         "id": 65
69       },
70       "translation_key_name": "endpoint_data_traffic_limit_warning_n",
71       "translation_key_description": "endpoint_data_traffic_limit_warning_d",
72       "supported_targeting_parameters": [
73         {
74           "parameter": "service_policy",
75           "type": "number[]",
76           "description": "Service Policy"
77         },
78         {
79           "parameter": "endpoint_tag",
80           "type": "string[]",
81           "description": "Endpoint Tag",
82           "validators": [
83             {
84               "type": "minCount",
85               "value": 1
86             }
87           ]
88         }
89       ],
90       "supported_actions": [
91         {
92           "id": "system-send_notification_with_email",
93           "status": "active",
94           "type": "system",
95           "configuration_properties": [
96             {
97               "property": "recipients",
98               "type": "email[]",
99               "default": null,
100               "required": true,
101               "description": "List of email addresses to notify"
102             }
103           ],
104           "name": "Send notification via email",
105           "description": "Send notification via email",
106           "translation_key_name": "Send notification with email N",
107           "translation_key_description": "Send notification with email D",
108           "required_event_output_parameters": [
109             {
110               "parameter": "event_description",
111               "type": "string",
112               "description": "Standard description of the event"
113             }
114           ]
115         }
116       ]
117     }
118   },
119   "configured_actions": [
120     {
121       "action": {
122         "id": "system-send_notification_with_email",
123         "status": "active",
124         "type": "system",
125         "configuration_properties": [
126           {
127             "property": "recipients",
128             "type": "email[]",
129             "default": null,
130             "required": true,
131             "description": "List of email addresses to notify"
132           }
133         ],
134         "name": "Send notification with email",
135         "description": "Send notification with email",
136         "translation_key_name": "Send notification with email N",
137         "translation_key_description": "Send notification with email D",
138         "required_event_output_parameters": [
139           {
140             "parameter": "event_description",
141             "type": "string",
142             "description": "Standard description of the event"
143           }
144         ]
145       },
146       "properties": [
147         {
148           "property": "recipients",
149           "value": "string",
150           "value_array": [
151             "foo@bar.emnify"
152           ]
153         }
154       ],
155       "recipients": {
156         "email": [
157           "string"
158         ]
159       }
160     }
161   ],
162   "targeting_properties": [
163     {
164       "property": "service_policy",
165       "value": "string",
166       "value_array": [
167         "3"
168       ]
169     }
170   ],
171   "created_by": {
172     "id": 1,
173     "name": "John Doe"
174   }
175 }

Creates an automation with the configured event and selected actions, respecting the configured targets.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

descriptionstringRequired

statusstringRequired

actionable_eventobjectRequired

configured_actionslist of objectsRequired

targeting_propertieslist of objectsRequired

Response

idstring

namestring

descriptionstring

statusstring

organisationobject

number_of_executionsdouble

last_executionstring

created_atstring

modified_atstring

actionable_eventobject

configured_actionslist of objects

targeting_propertieslist of objects

$	curl -X POST https://cdn.emnify.net/api/v1/automation \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Send email notification for custom event",
>	"description": "Sends a notification via Email for custom event.\n",
>	"status": "active",
>	"actionable_event": {
>	"custom_event": {
>	"id": "2"
>	},
>	"system_event": {
>	"id": "string"
>	}
>	},
>	"configured_actions": [
>	{
>	"action": {
>	"id": "system-send_notification_with_email"
>	},
>	"properties": [
>	{
>	"property": "recipients",
>	"value": "string",
>	"value_array": [
>	"foo@bar.emnify"
>	]
>	}
>	]
>	}
>	],
>	"targeting_properties": [
>	{
>	"property": "service_policy",
>	"value": "string",
>	"value_array": [
>	"2"
>	]
>	}
>	]
>	}'

1	{
2	"id": "56",
3	"name": "Endpoint data traffic limit warning email",
4	"description": "Sends an email when the endpoint data traffic limit warning is triggered for service profile 3.\n",
5	"status": "active",
6	"organisation": {
7	"id": 1550
8	},
9	"number_of_executions": 3,
10	"last_execution": "2025-01-01T00:00:00.000Z",
11	"created_at": "2024-01-01T03:00:00.000Z",
12	"modified_at": "2024-05-06T05:00:00.000Z",
13	"actionable_event": {
14	"custom_event": {
15	"organisation": {
16	"id": 1.1
17	},
18	"template": {
19	"id": 1.1
20	},
21	"configuration_properties": [
22	{
23	"property": "string",
24	"value": "string",
25	"value_array": [
26	"string"
27	]
28	}
29	],
30	"name": "string",
31	"id": "string",
32	"supportedTargetingParameters": [
33	"string"
34	],
35	"supportedActions": [
36	"string"
37	]
38	},
39	"system_event": {
40	"id": "605",
41	"parentOrg": {
42	"id": 1.1
43	},
44	"eventType": {
45	"id": 1.1
46	},
47	"name": "Endpoint data traffic limit warning",
48	"translationKeyName": "string",
49	"description": "Endpoint data traffic limit warning",
50	"translationKeyDescription": "string",
51	"supportedTargetingParameters": [
52	"string"
53	],
54	"eventOutputParameters": [
55	{
56	"parameter": "string",
57	"type": "string",
58	"description": "string"
59	}
60	],
61	"supportedActions": [
62	"string"
63	],
64	"parent_organisation": {
65	"id": 2
66	},
67	"event_type": {
68	"id": 65
69	},
70	"translation_key_name": "endpoint_data_traffic_limit_warning_n",
71	"translation_key_description": "endpoint_data_traffic_limit_warning_d",
72	"supported_targeting_parameters": [
73	{
74	"parameter": "service_policy",
75	"type": "number[]",
76	"description": "Service Policy"
77	},
78	{
79	"parameter": "endpoint_tag",
80	"type": "string[]",
81	"description": "Endpoint Tag",
82	"validators": [
83	{
84	"type": "minCount",
85	"value": 1
86	}
87	]
88	}
89	],
90	"supported_actions": [
91	{
92	"id": "system-send_notification_with_email",
93	"status": "active",
94	"type": "system",
95	"configuration_properties": [
96	{
97	"property": "recipients",
98	"type": "email[]",
99	"default": null,
100	"required": true,
101	"description": "List of email addresses to notify"
102	}
103	],
104	"name": "Send notification via email",
105	"description": "Send notification via email",
106	"translation_key_name": "Send notification with email N",
107	"translation_key_description": "Send notification with email D",
108	"required_event_output_parameters": [
109	{
110	"parameter": "event_description",
111	"type": "string",
112	"description": "Standard description of the event"
113	}
114	]
115	}
116	]
117	}
118	},
119	"configured_actions": [
120	{
121	"action": {
122	"id": "system-send_notification_with_email",
123	"status": "active",
124	"type": "system",
125	"configuration_properties": [
126	{
127	"property": "recipients",
128	"type": "email[]",
129	"default": null,
130	"required": true,
131	"description": "List of email addresses to notify"
132	}
133	],
134	"name": "Send notification with email",
135	"description": "Send notification with email",
136	"translation_key_name": "Send notification with email N",
137	"translation_key_description": "Send notification with email D",
138	"required_event_output_parameters": [
139	{
140	"parameter": "event_description",
141	"type": "string",
142	"description": "Standard description of the event"
143	}
144	]
145	},
146	"properties": [
147	{
148	"property": "recipients",
149	"value": "string",
150	"value_array": [
151	"foo@bar.emnify"
152	]
153	}
154	],
155	"recipients": {
156	"email": [
157	"string"
158	]
159	}
160	}
161	],
162	"targeting_properties": [
163	{
164	"property": "service_policy",
165	"value": "string",
166	"value_array": [
167	"3"
168	]
169	}
170	],
171	"created_by": {
172	"id": 1,
173	"name": "John Doe"
174	}
175	}