EntryPoint

Represents data about the entry point that opened a plugin. Available from the Context object.

Properties

Property

Type

Description

type

String

Specifies the location from which the user opened the plugin. One of:

  • SIDE_PANEL
  • COMPOSER_TOOLBAR
  • CONTACT_HANDLE
  • URL

data

PhoneEntryPointData | CustomContextProperties | Undefined

EntryPoint specific data. Currently only available for plugins opened through a contact's phone handle or through a URL found in a Front message or comment.

PhoneEntryPointData

Only available for EntryPoint of type CONTACT_HANDLE

Properties

PropertyTypeDescription
typephoneThe type of entry point data. In this case, it will be phone since the plugin was opened from a contact's phone handle.
handleStringThe phone handle that was clicked to open the plugin.
timestampDateThe time at which the phone handle was clicked as a Unix timestamp.

CustomContextProperties

Only available for EntryPoint of type URL

Properties

PropertyTypeDescription
custom property nameStringThe custom properties passed as query strings in the URL that opened the sidebar plugin.