Create an automation | emnify Documentation

import requests
url = "https://cdn.emnify.net/api/v1/automation"
payload = {
    "name": "Notify admin on endpoint data traffic limit warning",
    "description": "Automatically sends an email notification to the admin when the endpoint data traffic limit warning event is triggered for service profile 3.",
    "status": "active",
    "actionable_event": {
        "custom_event": { "id": "0" },
        "system_event": { "id": "605" }
    },
    "configured_actions": [
        {
            "action": { "id": "system-send_notification_with_email" },
            "properties": [
                {
                    "property": "recipients",
                    "value": "admin@company.com",
                    "value_array": ["admin@company.com"]
                }
            ]
        }
    ],
    "targeting_properties": [
        {
            "property": "service_policy",
            "value": "3",
            "value_array": ["3"]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "56",
  "name": "Endpoint data traffic limit warning email",
  "description": "Sends an email when the endpoint data traffic limit warning is triggered for service profile 3.\n",
  "status": "active",
  "organisation": {
    "id": 1550
  },
  "number_of_executions": 3,
  "last_execution": "2025-01-01T00:00:00.000Z",
  "created_at": "2024-01-01T03:00:00.000Z",
  "modified_at": "2024-05-06T05:00:00.000Z",
  "actionable_event": {
    "custom_event": {
      "organisation": {
        "id": 1
      },
      "template": {
        "id": 1
      },
      "configuration_properties": [
        {
          "property": "threshold",
          "value": "80",
          "value_array": [
            "80"
          ]
        }
      ],
      "name": "Data Usage Threshold Exceeded",
      "id": "evt-1234",
      "supportedTargetingParameters": [
        "service_policy",
        "endpoint_tag"
      ],
      "supportedActions": [
        "system-send_notification_with_email",
        "system-log_event"
      ]
    },
    "system_event": {
      "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": [
        "service_policy",
        "endpoint_tag"
      ],
      "eventOutputParameters": [
        {
          "parameter": "event_description",
          "type": "string",
          "description": "Standard description of the event"
        }
      ],
      "supportedActions": [
        "system-send_notification_with_email"
      ]
    }
  },
  "configured_actions": [
    {
      "action": {
        "id": "system-send_notification_with_email"
      },
      "properties": [
        {
          "property": "recipients",
          "value": "admin@company.com",
          "value_array": [
            "admin@company.com"
          ]
        }
      ],
      "recipients": {
        "email": [
          "admin@company.com"
        ]
      }
    }
  ],
  "targeting_properties": [
    {
      "property": "service_policy",
      "value": "3",
      "value_array": [
        "3"
      ]
    }
  ]
}

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