Get a custom event template by ID

Pre-release

GET

https://cdn.emnify.net/api/v1/event/custom/template/:template_id

GET

/api/v1/event/custom/template/:template_id

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

200Custom Event Template by ID

{
  "id": "1",
  "parent_organisation": {
    "id": 2
  },
  "name": "PDP Threshold Count Over Time",
  "translationKeyName": "string",
  "status": "published",
  "description": "This event is triggered when more than [number] PDPs are created in [time].\n",
  "translationKeyDescription": "string",
  "configuration_properties": [
    {
      "property": "count_of_pdp",
      "type": "integer",
      "default": "5",
      "required": true,
      "description": "Number of PDP connections",
      "validators": [
        {
          "validator_type": "string",
          "validator_value": "string"
        }
      ]
    },
    {
      "property": "duration",
      "type": "string",
      "default": "1w",
      "required": true,
      "description": "Duration of the PDP connection period (for example, '1D', '1w')",
      "validators": [
        {
          "validator_type": "string",
          "validator_value": "string"
        }
      ]
    }
  ],
  "supported_targeting_parameters": [
    {
      "parameter": "service_policy",
      "type": "number[]",
      "description": "Service Policy",
      "validators": [
        {
          "validator_type": "string",
          "validator_value": "string"
        }
      ]
    },
    {
      "parameter": "endpoint_tag",
      "type": "string[]",
      "description": "Endpoint Tag",
      "validators": [
        {
          "validator_type": "string",
          "validator_value": "string"
        }
      ]
    }
  ],
  "supported_action_ids": [
    "system-send_notification_with_email"
  ],
  "translation_key_description": "PDP_THRESHOLD_COUNT_OVER_TIME_D",
  "translation_key_name": "PDP_THRESHOLD_COUNT_OVER_TIME_N"
}

Retrieves a specific custom event template and its possible configuration parameters. A template’s supported_action_ids declares which actions are offered for the custom events deployed from it. Templates aren’t created through the API, so this list changes only with an emnify release.

Authentication

AuthorizationBearer

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

Path parameters

template_idstringRequired

Response

idstring

parent_organisationobject

namestring

translationKeyNamestring

statusstring

descriptionstring

translationKeyDescriptionstring

configuration_propertieslist of objects

supported_targeting_parameterslist of objects

supported_action_idslist of stringsOptional

Action IDs the custom events deployed from this template declare support for, used to decide which actions are offered for those events.

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.