Deploy custom event

Pre-release

POST

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

POST

/api/v1/event/custom/configuration

curl -X POST https://cdn.emnify.net/api/v1/event/custom/configuration \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "organisation": {
    "id": 200
  },
  "template": {
    "id": 1
  },
  "configuration_properties": [
    {
      "property": "count_of_pdp",
      "value": "10",
      "value_array": [
        "string"
      ]
    },
    {
      "property": "duration",
      "value": "1w",
      "value_array": [
        "string"
      ]
    }
  ],
  "name": "PDP Threshold 50 Over One Week"
}'

201Deployed

{
  "organisation": {
    "id": 200
  },
  "template": {
    "id": 1
  },
  "configuration_properties": [
    {
      "property": "count_of_pdp",
      "value": "10",
      "value_array": [
        "string"
      ]
    },
    {
      "property": "duration",
      "value": "1w",
      "value_array": [
        "string"
      ]
    }
  ],
  "name": "PDP Threshold 50 Over One Week",
  "id": "2",
  "supportedTargetingParameters": [
    "string"
  ],
  "supportedActions": [
    "string"
  ],
  "supported_action_ids": [
    "system-send_notification_with_email"
  ],
  "supported_actions": [
    {
      "configuration_properties": [
        {
          "default": null,
          "description": "List of email addresses to notify",
          "property": "recipients",
          "required": true,
          "type": "email[]"
        }
      ],
      "description": "Send notification via email",
      "id": "system-send_notification_with_email",
      "name": "Send notification via email",
      "required_event_output_parameters": [
        {
          "description": "Standard description of the event",
          "parameter": "event_description",
          "type": "string"
        }
      ],
      "status": "active",
      "translation_key_description": "Send notification with email D",
      "translation_key_name": "Send notification with email N",
      "type": "system"
    }
  ],
  "supported_targeting_parameters": [
    {
      "description": "Service Policy",
      "parameter": "service_policy",
      "type": "number[]"
    },
    {
      "description": "Endpoint Tag",
      "parameter": "endpoint_tag",
      "type": "string[]"
    }
  ]
}

Deploys a custom event with the specified configuration. A custom event inherits supported_action_ids from its template’s current state, so it changes if the template does.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

organisationobjectRequired

templateobjectRequired

configuration_propertieslist of objectsRequired

namestringRequired

Response

organisationobject

templateobject

configuration_propertieslist of objects

namestring

idstring

supportedTargetingParameterslist of strings

supportedActionslist of strings

supported_action_idslist of stringsOptional

Action IDs this event declares support for, used to decide which actions are offered for it.

Field absent: no restriction is declared, so every action whose required_event_output_parameters the event emits is offered.
Empty array: a declaration in its own right, so no actions are offered.
Non-empty list: intersected with the parameter check, so a listed action is offered only if the event also emits every parameter that action requires.

The list can only narrow what’s offered, never widen it.