customEvents

Get a custom event by ID

Retrieves a specific custom event and its supported targeting options. A custom event inherits supported_action_ids from its template's current state, so it changes if the template does.

get/api/v1/event/custom/configuration/{custom_event_id}

Request

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

Path parameters

custom_event_idstring required

Response

namestring required
idstring required
supportedTargetingParametersstring[] required
supportedActionsstring[] required
supported_action_idsstring[]

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.

Changes

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