Visit composer

The app is displayed as an icon in the toolbar of the visit editor. Clicking the icon opens the app. A visit editor app typically adds functionality to the editor.

image

Example manifest

"location": {
  "sell": {
    "visit_editor": "assets/iframe.html"
  }
},

The following object is available in this location:

Visit object

visit

Retrieves the visit object with some of its properties.

get
client.get('visit')
returns
{
  "visit": {
    "id": 4,
    "resourceType": "contact",
    "resourceId": 12345
  }
}

Properties

visit.id

The unique identifier of the visit.

get
client.get('visit.id')
returns
{
  "visit.id": 4
}
visit.resourceType

Type of an entity the visit was created on

get
client.get('visit.resourceType')
returns
{
  "visit.resourceType": "contact"
}
visit.resourceId

The unique identifier of an entity the visit was created on.

get
client.get('visit.resourceId')
returns
{
  "visit.resourceId": 12345
}