Send Event

Trigger a Singlewire event programmatically.

Function

DeviceAPI.SendEvent(eventId, options)

Parameters

Name
Type
Required
Description

eventId

string

Singlewire Event ID (from CustomEvents config)

options

table

Extra settings

Options Table

{
    source = "panic_button", -- optional label for logging/devices
    player = Player           -- REQUIRED for live (Message Type 0) events
}

Examples

Non-Live Event

DeviceAPI.SendEvent("911", {
    source = "panic button"
})

Live Paging Event

Return Values

Common reasons:

  • ended

  • busy

  • no_power

  • unknown_event

  • live_requires_player

Last updated