user_event

Allows the user to set and send events to the connected client on the call. This is useful for triggering actions on the client side. Commonly used with the browser-sdk. Accepts an object mapping event names to values. The event object can be any valid JSON object.

Name	Type	Default	Description
user_eventRequired	object	-	An object that contains the user_event parameters.

user_event Parameters

Name	Type	Default	Description
eventRequired	any	-	An object mapping event names to values. The event object can be any valid JSON object.

Event Object

The event parameter can be any valid JSON object. Any key-value pair in the object is sent to the client as an event type called: user_event.

The client can listen for these events using the on-method.

Examples

Send a custom event to the client

YAML

version: 1.0.0
sections:
  main:
    - user_event:
        event:
          myCustomEvent: 'Hello, world!'
    - play:
        url: 'say: Custom event sent.'

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "user_event": {
          "event": {
            "myCustomEvent": "Hello, world!"
          }
        }
      },
      {
        "play": {
          "url": "say: Custom event sent."
        }
      }
    ]
  }
}

Send multiple events with different payloads

YAML

version: 1.0.0
sections:
  main:
    - user_event:
        event:
          eventA:
            foo: bar
          eventB:
            count: 42
            active: true
    - play:
        url: 'say: Multiple events sent.'

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "user_event": {
          "event": {
            "eventA": {
              "foo": "bar"
            },
            "eventB": {
              "count": 42,
              "active": true
            }
          }
        }
      },
      {
        "play": {
          "url": "say: Multiple events sent."
        }
      }
    ]
  }
}