customEvents

Get a custom event template by ID

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.

get/api/v1/event/custom/template/{template_id}

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/event/custom/template/{template_id}
  • Auth: HTTP bearer

Path parameters

template_idstring required

Response

idstring required
namestring required
translationKeyNamestring required
status'active' | 'disabled' required
descriptionstring required
translationKeyDescriptionstring required
supported_action_idsstring[]

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.

Changes

No recorded changes to this operation across all 1 revision of this API.