Skip to end of metadata
Go to start of metadata

digium.event.fire

Description

Fire an event of the given eventName and pass your eventData onto any callback that may be observing the event. Note: the list of Digium eventNames cannot be fired except by the system.

 

Basic Example: 


Parameters

 

NameRequiredTypeDefaultDescription
eventName
Yes
string
 

String that identifies the event type. Event type can either be from this list if you are using digium.event.observe, or from your own list if you're using digium.event.fire to fire your own event. 

eventData
Yes
object
 

Object passed to any callbacks listening for this event. eventData can contain a 'callback' property that will be executed when an event named eventName.response (for example, contacts.forwardVM.response) is sent with the same messageId.

messageId
No
object
 

Unique ID for the message. If messageId is not specified one will be generated automatically.

Icon

A full list of system eventNames can be found here

  • No labels