VirtualStore

Interact with VirtualStore API to manage reservations, stores, and hosts

Triggers

Events from this node that can start a flow. Add one from Choose a trigger.

Reservation Created

Triggered when a reservation is created

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, session is $trigger.output.session.

{
  "session": {},
  "guests": [
    {
      "id": "string",
      "familyName": "string",
      "firstName": "string",
      "familyFurigana": "string",
      "firstFurigana": "string",
      "familyKatakana": "string",
      "firstKatakana": "string",
      "phoneNumber": "string",
      "line": {},
      "email": "string",
      "hashId": "string",
      "visitorId": "string",
      "isBooker": false,
      "identity": "string",
      "fullName": "string",
      "externalId": "string",
      "webId": "string",
      "isSurveyEnabled": false
    }
  ],
  "store": {},
  "equipment": {},
  "hosts": [
    {
      "id": "string",
      "email": "string",
      "fullName": "string",
      "profile": {},
      "displayName": "string"
    }
  ]
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
session	Object	Session payload in VirtualStore reservation and survey response events
session.id	Text	Session ID
session.oid	Text	Organization ID of the session
session.flow	Text	Reservation flow
session.status	Text	Session status
session.type	Text	Session type (e.g. online, offline)
session.startAt	Text	Session start timestamp (ISO 8601)
session.endAt	Text	Session end timestamp (ISO 8601)
session.createdAt	Text	Created at timestamp (ISO 8601)
session.updatedAt	Text	Updated at timestamp (ISO 8601)
session.isPrivate	Yes / No	Whether the session is private
session.isRestorable	Yes / No	Whether the reservation can be restored
session.isTest	Yes / No	Whether this is a test session
session.isChangeable	Yes / No	Whether the reservation can be changed
session.isHostSelection	Yes / No	Whether host selection is enabled
session.urlType	Text	URL type used when creating the session
session.rescheduledAt	Text	Rescheduled at timestamp (ISO 8601)
session.originalHostId	Text	Original host ID before reschedule
session.isRecorded	Yes / No	Whether the session is recorded
session.duration	Object	Duration detail of a reservation session in VirtualStore events
session.duration.name	Text	Duration name
session.duration.duration	Number	Duration in minutes
session.duration.description	Text	Duration description
session.duration.bufferTime	Number	Buffer time in minutes
session.duration.membership	Text	Membership associated with duration
session.duration.memberMode	Text	Member mode associated with duration
session.responses[]	List	Survey results / responses for the session. Holds every survey response on the session (all guests), not only the newest one; group by responseId / resourceId
session.responses[].id	Text	Answer ID
session.responses[].surveyId	Text	Survey ID
session.responses[].resourceType	Text	Response resource type (guest | identity)
session.responses[].resourceId	Text	Response resource ID (guest ID)
session.responses[].responseId	Text	Response ID
session.responses[].questionId	Text	Question ID
session.responses[].questionTitle	Text	Question title
session.responses[].questionExplanation	Text	Question explanation
session.responses[].questionType	Text	Question field type
session.responses[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.responses[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.responses[].branchCode	Text	Parsed branch code from answer
session.responses[].otherAnswer	Text	Other answer text when applicable
session.responses[].assets[]	List	Assets attached to the answer
session.responses[].assets[].id	Text	Asset ID
session.responses[].assets[].name	Text	Asset name
session.responses[].assets[].url	Text	Asset URL
session.responses[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.responses[].assets[].mimeType	Text	MIME type of the asset
session.responses[].assets[].size	Number	Asset size in bytes
session.responses[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.responses[].assets[].status	Text	Asset status
session.answers[]	List	Hearing form answers for the session
session.answers[].id	Text	Answer ID
session.answers[].surveyId	Text	Survey ID
session.answers[].resourceType	Text	Response resource type (guest | identity)
session.answers[].resourceId	Text	Response resource ID (guest ID)
session.answers[].responseId	Text	Response ID
session.answers[].questionId	Text	Question ID
session.answers[].questionTitle	Text	Question title
session.answers[].questionExplanation	Text	Question explanation
session.answers[].questionType	Text	Question field type
session.answers[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.answers[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.answers[].branchCode	Text	Parsed branch code from answer
session.answers[].otherAnswer	Text	Other answer text when applicable
session.answers[].assets[]	List	Assets attached to the answer
session.answers[].assets[].id	Text	Asset ID
session.answers[].assets[].name	Text	Asset name
session.answers[].assets[].url	Text	Asset URL
session.answers[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.answers[].assets[].mimeType	Text	MIME type of the asset
session.answers[].assets[].size	Number	Asset size in bytes
session.answers[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.answers[].assets[].status	Text	Asset status
session.systemReadiness	Object	System readiness checks for a reservation session
session.systemReadiness.micro	Yes / No	Microphone readiness
session.systemReadiness.camera	Yes / No	Camera readiness
session.systemReadiness.browser	Yes / No	Browser readiness
session.systemReadiness.speaker	Yes / No	Speaker readiness
session.cancelledReason	Text	Reason for cancellation
session.cancelledBy	Text	Who cancelled the session
guests[]	List	Guests of the reservation
guests[].id	Text	Guest ID
guests[].familyName	Text	Family name of guest
guests[].firstName	Text	First name of guest
guests[].familyFurigana	Text	Family name in furigana
guests[].firstFurigana	Text	First name in furigana
guests[].familyKatakana	Text	Family name in katakana
guests[].firstKatakana	Text	First name in katakana
guests[].phoneNumber	Text	Guest phone number
guests[].line	Object	LINE profile of a guest in VirtualStore events
guests[].line.id	Text	LINE user ID (with U prefix)
guests[].line.name	Text	LINE display name
guests[].line.avatar	Text	LINE avatar URL
guests[].line.isFriend	Yes / No	Whether the guest is a LINE friend
guests[].email	Text	Guest email
guests[].hashId	Text	Guest hashed ID
guests[].visitorId	Text	Visitor ID
guests[].isBooker	Yes / No	Whether this guest is the booker
guests[].identity	Text	Guest identity
guests[].fullName	Text	Full name of guest
guests[].externalId	Text	Guest external ID
guests[].webId	Text	Guest web ID
guests[].isSurveyEnabled	Yes / No	Whether survey is enabled for guest
store	Object	Store payload in VirtualStore events
store.id	Text	Store ID
store.name	Text	Store name
store.timezone	Text	Store timezone
store.logo	Object	Asset payload in VirtualStore events
store.logo.id	Text	Asset ID
store.logo.name	Text	Asset name
store.logo.url	Text	Asset URL
store.logo.createdAt	Text	Created at timestamp (ISO 8601)
store.logo.mimeType	Text	MIME type of the asset
store.logo.size	Number	Asset size in bytes
store.logo.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.logo.meta.thumbnails[]	List	Generated thumbnail variants
store.logo.status	Text	Asset status
store.image	Object	Asset payload in VirtualStore events
store.image.id	Text	Asset ID
store.image.name	Text	Asset name
store.image.url	Text	Asset URL
store.image.createdAt	Text	Created at timestamp (ISO 8601)
store.image.mimeType	Text	MIME type of the asset
store.image.size	Number	Asset size in bytes
store.image.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.image.meta.thumbnails[]	List	Generated thumbnail variants
store.image.status	Text	Asset status
equipment	Object	Equipment payload for offline reservations in VirtualStore events
equipment.id	Text	Equipment ID
equipment.name	Text	Equipment name
equipment.status	Text	Equipment status
equipment.description	Text	Equipment description
equipment.avatar	Object	Asset payload in VirtualStore events
equipment.avatar.id	Text	Asset ID
equipment.avatar.name	Text	Asset name
equipment.avatar.url	Text	Asset URL
equipment.avatar.createdAt	Text	Created at timestamp (ISO 8601)
equipment.avatar.mimeType	Text	MIME type of the asset
equipment.avatar.size	Number	Asset size in bytes
equipment.avatar.meta	Object	Asset metadata (optional; e.g. thumbnails)
equipment.avatar.meta.thumbnails[]	List	Generated thumbnail variants
equipment.avatar.status	Text	Asset status
hosts[]	List	Hosts of the reservation (the single item is null when no host is assigned)
hosts[].id	Text	Host ID
hosts[].email	Text	Host email
hosts[].fullName	Text	Host full name
hosts[].profile	Object	Host profile payload in VirtualStore events
hosts[].profile.introduction	Text	Host introduction
hosts[].profile.position	Text	Host position
hosts[].profile.url	Text	Host profile URL
hosts[].profile.twitter	Text	Host Twitter handle
hosts[].profile.facebook	Text	Host Facebook profile
hosts[].profile.instagram	Text	Host Instagram profile
hosts[].profile.nickname	Text	Host nickname
hosts[].profile.avatar	Object	Asset payload in VirtualStore events
hosts[].profile.avatar.id	Text	Asset ID
hosts[].profile.avatar.name	Text	Asset name
hosts[].profile.avatar.url	Text	Asset URL
hosts[].profile.avatar.createdAt	Text	Created at timestamp (ISO 8601)
hosts[].profile.avatar.mimeType	Text	MIME type of the asset
hosts[].profile.avatar.size	Number	Asset size in bytes
hosts[].profile.avatar.meta	Object	Asset metadata (optional; e.g. thumbnails)
hosts[].profile.avatar.status	Text	Asset status
hosts[].displayName	Text	Host display name

Reservation Updated

Triggered when a reservation is updated (including when it is terminated)

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, session is $trigger.output.session.

{
  "session": {},
  "guests": [
    {
      "id": "string",
      "familyName": "string",
      "firstName": "string",
      "familyFurigana": "string",
      "firstFurigana": "string",
      "familyKatakana": "string",
      "firstKatakana": "string",
      "phoneNumber": "string",
      "line": {},
      "email": "string",
      "hashId": "string",
      "visitorId": "string",
      "isBooker": false,
      "identity": "string",
      "fullName": "string",
      "externalId": "string",
      "webId": "string",
      "isSurveyEnabled": false
    }
  ],
  "store": {},
  "equipment": {},
  "hosts": [
    {
      "id": "string",
      "email": "string",
      "fullName": "string",
      "profile": {},
      "displayName": "string"
    }
  ]
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
session	Object	Session payload in VirtualStore reservation and survey response events
session.id	Text	Session ID
session.oid	Text	Organization ID of the session
session.flow	Text	Reservation flow
session.status	Text	Session status
session.type	Text	Session type (e.g. online, offline)
session.startAt	Text	Session start timestamp (ISO 8601)
session.endAt	Text	Session end timestamp (ISO 8601)
session.createdAt	Text	Created at timestamp (ISO 8601)
session.updatedAt	Text	Updated at timestamp (ISO 8601)
session.isPrivate	Yes / No	Whether the session is private
session.isRestorable	Yes / No	Whether the reservation can be restored
session.isTest	Yes / No	Whether this is a test session
session.isChangeable	Yes / No	Whether the reservation can be changed
session.isHostSelection	Yes / No	Whether host selection is enabled
session.urlType	Text	URL type used when creating the session
session.rescheduledAt	Text	Rescheduled at timestamp (ISO 8601)
session.originalHostId	Text	Original host ID before reschedule
session.isRecorded	Yes / No	Whether the session is recorded
session.duration	Object	Duration detail of a reservation session in VirtualStore events
session.duration.name	Text	Duration name
session.duration.duration	Number	Duration in minutes
session.duration.description	Text	Duration description
session.duration.bufferTime	Number	Buffer time in minutes
session.duration.membership	Text	Membership associated with duration
session.duration.memberMode	Text	Member mode associated with duration
session.responses[]	List	Survey results / responses for the session. Holds every survey response on the session (all guests), not only the newest one; group by responseId / resourceId
session.responses[].id	Text	Answer ID
session.responses[].surveyId	Text	Survey ID
session.responses[].resourceType	Text	Response resource type (guest | identity)
session.responses[].resourceId	Text	Response resource ID (guest ID)
session.responses[].responseId	Text	Response ID
session.responses[].questionId	Text	Question ID
session.responses[].questionTitle	Text	Question title
session.responses[].questionExplanation	Text	Question explanation
session.responses[].questionType	Text	Question field type
session.responses[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.responses[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.responses[].branchCode	Text	Parsed branch code from answer
session.responses[].otherAnswer	Text	Other answer text when applicable
session.responses[].assets[]	List	Assets attached to the answer
session.responses[].assets[].id	Text	Asset ID
session.responses[].assets[].name	Text	Asset name
session.responses[].assets[].url	Text	Asset URL
session.responses[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.responses[].assets[].mimeType	Text	MIME type of the asset
session.responses[].assets[].size	Number	Asset size in bytes
session.responses[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.responses[].assets[].status	Text	Asset status
session.answers[]	List	Hearing form answers for the session
session.answers[].id	Text	Answer ID
session.answers[].surveyId	Text	Survey ID
session.answers[].resourceType	Text	Response resource type (guest | identity)
session.answers[].resourceId	Text	Response resource ID (guest ID)
session.answers[].responseId	Text	Response ID
session.answers[].questionId	Text	Question ID
session.answers[].questionTitle	Text	Question title
session.answers[].questionExplanation	Text	Question explanation
session.answers[].questionType	Text	Question field type
session.answers[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.answers[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.answers[].branchCode	Text	Parsed branch code from answer
session.answers[].otherAnswer	Text	Other answer text when applicable
session.answers[].assets[]	List	Assets attached to the answer
session.answers[].assets[].id	Text	Asset ID
session.answers[].assets[].name	Text	Asset name
session.answers[].assets[].url	Text	Asset URL
session.answers[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.answers[].assets[].mimeType	Text	MIME type of the asset
session.answers[].assets[].size	Number	Asset size in bytes
session.answers[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.answers[].assets[].status	Text	Asset status
session.systemReadiness	Object	System readiness checks for a reservation session
session.systemReadiness.micro	Yes / No	Microphone readiness
session.systemReadiness.camera	Yes / No	Camera readiness
session.systemReadiness.browser	Yes / No	Browser readiness
session.systemReadiness.speaker	Yes / No	Speaker readiness
session.cancelledReason	Text	Reason for cancellation
session.cancelledBy	Text	Who cancelled the session
guests[]	List	Guests of the reservation
guests[].id	Text	Guest ID
guests[].familyName	Text	Family name of guest
guests[].firstName	Text	First name of guest
guests[].familyFurigana	Text	Family name in furigana
guests[].firstFurigana	Text	First name in furigana
guests[].familyKatakana	Text	Family name in katakana
guests[].firstKatakana	Text	First name in katakana
guests[].phoneNumber	Text	Guest phone number
guests[].line	Object	LINE profile of a guest in VirtualStore events
guests[].line.id	Text	LINE user ID (with U prefix)
guests[].line.name	Text	LINE display name
guests[].line.avatar	Text	LINE avatar URL
guests[].line.isFriend	Yes / No	Whether the guest is a LINE friend
guests[].email	Text	Guest email
guests[].hashId	Text	Guest hashed ID
guests[].visitorId	Text	Visitor ID
guests[].isBooker	Yes / No	Whether this guest is the booker
guests[].identity	Text	Guest identity
guests[].fullName	Text	Full name of guest
guests[].externalId	Text	Guest external ID
guests[].webId	Text	Guest web ID
guests[].isSurveyEnabled	Yes / No	Whether survey is enabled for guest
store	Object	Store payload in VirtualStore events
store.id	Text	Store ID
store.name	Text	Store name
store.timezone	Text	Store timezone
store.logo	Object	Asset payload in VirtualStore events
store.logo.id	Text	Asset ID
store.logo.name	Text	Asset name
store.logo.url	Text	Asset URL
store.logo.createdAt	Text	Created at timestamp (ISO 8601)
store.logo.mimeType	Text	MIME type of the asset
store.logo.size	Number	Asset size in bytes
store.logo.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.logo.meta.thumbnails[]	List	Generated thumbnail variants
store.logo.status	Text	Asset status
store.image	Object	Asset payload in VirtualStore events
store.image.id	Text	Asset ID
store.image.name	Text	Asset name
store.image.url	Text	Asset URL
store.image.createdAt	Text	Created at timestamp (ISO 8601)
store.image.mimeType	Text	MIME type of the asset
store.image.size	Number	Asset size in bytes
store.image.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.image.meta.thumbnails[]	List	Generated thumbnail variants
store.image.status	Text	Asset status
equipment	Object	Equipment payload for offline reservations in VirtualStore events
equipment.id	Text	Equipment ID
equipment.name	Text	Equipment name
equipment.status	Text	Equipment status
equipment.description	Text	Equipment description
equipment.avatar	Object	Asset payload in VirtualStore events
equipment.avatar.id	Text	Asset ID
equipment.avatar.name	Text	Asset name
equipment.avatar.url	Text	Asset URL
equipment.avatar.createdAt	Text	Created at timestamp (ISO 8601)
equipment.avatar.mimeType	Text	MIME type of the asset
equipment.avatar.size	Number	Asset size in bytes
equipment.avatar.meta	Object	Asset metadata (optional; e.g. thumbnails)
equipment.avatar.meta.thumbnails[]	List	Generated thumbnail variants
equipment.avatar.status	Text	Asset status
hosts[]	List	Hosts of the reservation (the single item is null when no host is assigned)
hosts[].id	Text	Host ID
hosts[].email	Text	Host email
hosts[].fullName	Text	Host full name
hosts[].profile	Object	Host profile payload in VirtualStore events
hosts[].profile.introduction	Text	Host introduction
hosts[].profile.position	Text	Host position
hosts[].profile.url	Text	Host profile URL
hosts[].profile.twitter	Text	Host Twitter handle
hosts[].profile.facebook	Text	Host Facebook profile
hosts[].profile.instagram	Text	Host Instagram profile
hosts[].profile.nickname	Text	Host nickname
hosts[].profile.avatar	Object	Asset payload in VirtualStore events
hosts[].profile.avatar.id	Text	Asset ID
hosts[].profile.avatar.name	Text	Asset name
hosts[].profile.avatar.url	Text	Asset URL
hosts[].profile.avatar.createdAt	Text	Created at timestamp (ISO 8601)
hosts[].profile.avatar.mimeType	Text	MIME type of the asset
hosts[].profile.avatar.size	Number	Asset size in bytes
hosts[].profile.avatar.meta	Object	Asset metadata (optional; e.g. thumbnails)
hosts[].profile.avatar.status	Text	Asset status
hosts[].displayName	Text	Host display name

Reservation Cancelled

Triggered when a reservation is cancelled

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, session is $trigger.output.session.

{
  "session": {},
  "guests": [
    {
      "id": "string",
      "familyName": "string",
      "firstName": "string",
      "familyFurigana": "string",
      "firstFurigana": "string",
      "familyKatakana": "string",
      "firstKatakana": "string",
      "phoneNumber": "string",
      "line": {},
      "email": "string",
      "hashId": "string",
      "visitorId": "string",
      "isBooker": false,
      "identity": "string",
      "fullName": "string",
      "externalId": "string",
      "webId": "string",
      "isSurveyEnabled": false
    }
  ],
  "store": {},
  "equipment": {},
  "hosts": [
    {
      "id": "string",
      "email": "string",
      "fullName": "string",
      "profile": {},
      "displayName": "string"
    }
  ]
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
session	Object	Session payload in VirtualStore reservation and survey response events
session.id	Text	Session ID
session.oid	Text	Organization ID of the session
session.flow	Text	Reservation flow
session.status	Text	Session status
session.type	Text	Session type (e.g. online, offline)
session.startAt	Text	Session start timestamp (ISO 8601)
session.endAt	Text	Session end timestamp (ISO 8601)
session.createdAt	Text	Created at timestamp (ISO 8601)
session.updatedAt	Text	Updated at timestamp (ISO 8601)
session.isPrivate	Yes / No	Whether the session is private
session.isRestorable	Yes / No	Whether the reservation can be restored
session.isTest	Yes / No	Whether this is a test session
session.isChangeable	Yes / No	Whether the reservation can be changed
session.isHostSelection	Yes / No	Whether host selection is enabled
session.urlType	Text	URL type used when creating the session
session.rescheduledAt	Text	Rescheduled at timestamp (ISO 8601)
session.originalHostId	Text	Original host ID before reschedule
session.isRecorded	Yes / No	Whether the session is recorded
session.duration	Object	Duration detail of a reservation session in VirtualStore events
session.duration.name	Text	Duration name
session.duration.duration	Number	Duration in minutes
session.duration.description	Text	Duration description
session.duration.bufferTime	Number	Buffer time in minutes
session.duration.membership	Text	Membership associated with duration
session.duration.memberMode	Text	Member mode associated with duration
session.responses[]	List	Survey results / responses for the session. Holds every survey response on the session (all guests), not only the newest one; group by responseId / resourceId
session.responses[].id	Text	Answer ID
session.responses[].surveyId	Text	Survey ID
session.responses[].resourceType	Text	Response resource type (guest | identity)
session.responses[].resourceId	Text	Response resource ID (guest ID)
session.responses[].responseId	Text	Response ID
session.responses[].questionId	Text	Question ID
session.responses[].questionTitle	Text	Question title
session.responses[].questionExplanation	Text	Question explanation
session.responses[].questionType	Text	Question field type
session.responses[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.responses[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.responses[].branchCode	Text	Parsed branch code from answer
session.responses[].otherAnswer	Text	Other answer text when applicable
session.responses[].assets[]	List	Assets attached to the answer
session.responses[].assets[].id	Text	Asset ID
session.responses[].assets[].name	Text	Asset name
session.responses[].assets[].url	Text	Asset URL
session.responses[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.responses[].assets[].mimeType	Text	MIME type of the asset
session.responses[].assets[].size	Number	Asset size in bytes
session.responses[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.responses[].assets[].status	Text	Asset status
session.answers[]	List	Hearing form answers for the session
session.answers[].id	Text	Answer ID
session.answers[].surveyId	Text	Survey ID
session.answers[].resourceType	Text	Response resource type (guest | identity)
session.answers[].resourceId	Text	Response resource ID (guest ID)
session.answers[].responseId	Text	Response ID
session.answers[].questionId	Text	Question ID
session.answers[].questionTitle	Text	Question title
session.answers[].questionExplanation	Text	Question explanation
session.answers[].questionType	Text	Question field type
session.answers[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.answers[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.answers[].branchCode	Text	Parsed branch code from answer
session.answers[].otherAnswer	Text	Other answer text when applicable
session.answers[].assets[]	List	Assets attached to the answer
session.answers[].assets[].id	Text	Asset ID
session.answers[].assets[].name	Text	Asset name
session.answers[].assets[].url	Text	Asset URL
session.answers[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.answers[].assets[].mimeType	Text	MIME type of the asset
session.answers[].assets[].size	Number	Asset size in bytes
session.answers[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.answers[].assets[].status	Text	Asset status
session.systemReadiness	Object	System readiness checks for a reservation session
session.systemReadiness.micro	Yes / No	Microphone readiness
session.systemReadiness.camera	Yes / No	Camera readiness
session.systemReadiness.browser	Yes / No	Browser readiness
session.systemReadiness.speaker	Yes / No	Speaker readiness
session.cancelledReason	Text	Reason for cancellation
session.cancelledBy	Text	Who cancelled the session
guests[]	List	Guests of the reservation
guests[].id	Text	Guest ID
guests[].familyName	Text	Family name of guest
guests[].firstName	Text	First name of guest
guests[].familyFurigana	Text	Family name in furigana
guests[].firstFurigana	Text	First name in furigana
guests[].familyKatakana	Text	Family name in katakana
guests[].firstKatakana	Text	First name in katakana
guests[].phoneNumber	Text	Guest phone number
guests[].line	Object	LINE profile of a guest in VirtualStore events
guests[].line.id	Text	LINE user ID (with U prefix)
guests[].line.name	Text	LINE display name
guests[].line.avatar	Text	LINE avatar URL
guests[].line.isFriend	Yes / No	Whether the guest is a LINE friend
guests[].email	Text	Guest email
guests[].hashId	Text	Guest hashed ID
guests[].visitorId	Text	Visitor ID
guests[].isBooker	Yes / No	Whether this guest is the booker
guests[].identity	Text	Guest identity
guests[].fullName	Text	Full name of guest
guests[].externalId	Text	Guest external ID
guests[].webId	Text	Guest web ID
guests[].isSurveyEnabled	Yes / No	Whether survey is enabled for guest
store	Object	Store payload in VirtualStore events
store.id	Text	Store ID
store.name	Text	Store name
store.timezone	Text	Store timezone
store.logo	Object	Asset payload in VirtualStore events
store.logo.id	Text	Asset ID
store.logo.name	Text	Asset name
store.logo.url	Text	Asset URL
store.logo.createdAt	Text	Created at timestamp (ISO 8601)
store.logo.mimeType	Text	MIME type of the asset
store.logo.size	Number	Asset size in bytes
store.logo.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.logo.meta.thumbnails[]	List	Generated thumbnail variants
store.logo.status	Text	Asset status
store.image	Object	Asset payload in VirtualStore events
store.image.id	Text	Asset ID
store.image.name	Text	Asset name
store.image.url	Text	Asset URL
store.image.createdAt	Text	Created at timestamp (ISO 8601)
store.image.mimeType	Text	MIME type of the asset
store.image.size	Number	Asset size in bytes
store.image.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.image.meta.thumbnails[]	List	Generated thumbnail variants
store.image.status	Text	Asset status
equipment	Object	Equipment payload for offline reservations in VirtualStore events
equipment.id	Text	Equipment ID
equipment.name	Text	Equipment name
equipment.status	Text	Equipment status
equipment.description	Text	Equipment description
equipment.avatar	Object	Asset payload in VirtualStore events
equipment.avatar.id	Text	Asset ID
equipment.avatar.name	Text	Asset name
equipment.avatar.url	Text	Asset URL
equipment.avatar.createdAt	Text	Created at timestamp (ISO 8601)
equipment.avatar.mimeType	Text	MIME type of the asset
equipment.avatar.size	Number	Asset size in bytes
equipment.avatar.meta	Object	Asset metadata (optional; e.g. thumbnails)
equipment.avatar.meta.thumbnails[]	List	Generated thumbnail variants
equipment.avatar.status	Text	Asset status
hosts[]	List	Hosts of the reservation (the single item is null when no host is assigned)
hosts[].id	Text	Host ID
hosts[].email	Text	Host email
hosts[].fullName	Text	Host full name
hosts[].profile	Object	Host profile payload in VirtualStore events
hosts[].profile.introduction	Text	Host introduction
hosts[].profile.position	Text	Host position
hosts[].profile.url	Text	Host profile URL
hosts[].profile.twitter	Text	Host Twitter handle
hosts[].profile.facebook	Text	Host Facebook profile
hosts[].profile.instagram	Text	Host Instagram profile
hosts[].profile.nickname	Text	Host nickname
hosts[].profile.avatar	Object	Asset payload in VirtualStore events
hosts[].profile.avatar.id	Text	Asset ID
hosts[].profile.avatar.name	Text	Asset name
hosts[].profile.avatar.url	Text	Asset URL
hosts[].profile.avatar.createdAt	Text	Created at timestamp (ISO 8601)
hosts[].profile.avatar.mimeType	Text	MIME type of the asset
hosts[].profile.avatar.size	Number	Asset size in bytes
hosts[].profile.avatar.meta	Object	Asset metadata (optional; e.g. thumbnails)
hosts[].profile.avatar.status	Text	Asset status
hosts[].displayName	Text	Host display name

Memo Updated

Triggered when the memo of a reservation or direct session is updated

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, memo is $trigger.output.memo.

{
  "memo": "string",
  "session": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
memo	Text	Latest memo content
session	Object	Session that the memo belongs to
session.id	Text	ID of the reservation or direct session
session.type	Text	Session type: reservation or directsession

Direct Session Created

Triggered when a direct session is created

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, session is $trigger.output.session.

{
  "session": {},
  "guests": [
    {
      "id": "string",
      "familyName": "string",
      "firstName": "string",
      "familyFurigana": "string",
      "firstFurigana": "string",
      "familyKatakana": "string",
      "firstKatakana": "string",
      "phoneNumber": "string",
      "line": {},
      "email": "string",
      "hashId": "string",
      "visitorId": "string",
      "isBooker": false,
      "identity": "string",
      "fullName": "string",
      "externalId": "string",
      "webId": "string",
      "isSurveyEnabled": false
    }
  ],
  "store": {},
  "hosts": [
    {
      "id": "string",
      "email": "string",
      "fullName": "string",
      "profile": {},
      "displayName": "string"
    }
  ]
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
session	Object	Direct session payload in VirtualStore events
session.id	Text	Direct session ID
session.oid	Text	Organization ID of the direct session
session.status	Text	Direct session status
session.type	Text	Session type (always directsession)
session.startAt	Text	Direct session start timestamp (ISO 8601)
session.endAt	Text	Direct session end timestamp (ISO 8601), empty until the session ends
session.createdAt	Text	Created at timestamp (ISO 8601)
session.updatedAt	Text	Updated at timestamp (ISO 8601)
session.isPrivate	Yes / No	Whether the direct session is private
session.isTest	Yes / No	Whether this is a test direct session
session.urlType	Text	URL type used when creating the direct session
session.isRecorded	Yes / No	Whether the direct session is recorded
session.responses[]	List	Survey results of all guests for the direct session; empty until a guest submits the survey
session.responses[].id	Text	Answer ID
session.responses[].surveyId	Text	Survey ID
session.responses[].resourceType	Text	Response resource type (guest | identity)
session.responses[].resourceId	Text	Response resource ID (guest ID)
session.responses[].responseId	Text	Response ID
session.responses[].questionId	Text	Question ID
session.responses[].questionTitle	Text	Question title
session.responses[].questionExplanation	Text	Question explanation
session.responses[].questionType	Text	Question field type
session.responses[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.responses[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.responses[].branchCode	Text	Parsed branch code from answer
session.responses[].otherAnswer	Text	Other answer text when applicable
session.responses[].assets[]	List	Assets attached to the answer
session.responses[].assets[].id	Text	Asset ID
session.responses[].assets[].name	Text	Asset name
session.responses[].assets[].url	Text	Asset URL
session.responses[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.responses[].assets[].mimeType	Text	MIME type of the asset
session.responses[].assets[].size	Number	Asset size in bytes
session.responses[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.responses[].assets[].status	Text	Asset status
session.answers[]	List	Hearing form answers for the direct session
session.answers[].id	Text	Answer ID
session.answers[].surveyId	Text	Survey ID
session.answers[].resourceType	Text	Response resource type (guest | identity)
session.answers[].resourceId	Text	Response resource ID (guest ID)
session.answers[].responseId	Text	Response ID
session.answers[].questionId	Text	Question ID
session.answers[].questionTitle	Text	Question title
session.answers[].questionExplanation	Text	Question explanation
session.answers[].questionType	Text	Question field type
session.answers[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.answers[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.answers[].branchCode	Text	Parsed branch code from answer
session.answers[].otherAnswer	Text	Other answer text when applicable
session.answers[].assets[]	List	Assets attached to the answer
session.answers[].assets[].id	Text	Asset ID
session.answers[].assets[].name	Text	Asset name
session.answers[].assets[].url	Text	Asset URL
session.answers[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.answers[].assets[].mimeType	Text	MIME type of the asset
session.answers[].assets[].size	Number	Asset size in bytes
session.answers[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.answers[].assets[].status	Text	Asset status
session.cancelledReason	Text	Reason for cancellation
session.cancelledBy	Text	Who cancelled the direct session
guests[]	List	Guests of the direct session
guests[].id	Text	Guest ID
guests[].familyName	Text	Family name of guest
guests[].firstName	Text	First name of guest
guests[].familyFurigana	Text	Family name in furigana
guests[].firstFurigana	Text	First name in furigana
guests[].familyKatakana	Text	Family name in katakana
guests[].firstKatakana	Text	First name in katakana
guests[].phoneNumber	Text	Guest phone number
guests[].line	Object	LINE profile of a guest in VirtualStore events
guests[].line.id	Text	LINE user ID (with U prefix)
guests[].line.name	Text	LINE display name
guests[].line.avatar	Text	LINE avatar URL
guests[].line.isFriend	Yes / No	Whether the guest is a LINE friend
guests[].email	Text	Guest email
guests[].hashId	Text	Guest hashed ID
guests[].visitorId	Text	Visitor ID
guests[].isBooker	Yes / No	Whether this guest is the booker
guests[].identity	Text	Guest identity
guests[].fullName	Text	Full name of guest
guests[].externalId	Text	Guest external ID
guests[].webId	Text	Guest web ID
guests[].isSurveyEnabled	Yes / No	Whether survey is enabled for guest
store	Object	Store payload in VirtualStore events
store.id	Text	Store ID
store.name	Text	Store name
store.timezone	Text	Store timezone
store.logo	Object	Asset payload in VirtualStore events
store.logo.id	Text	Asset ID
store.logo.name	Text	Asset name
store.logo.url	Text	Asset URL
store.logo.createdAt	Text	Created at timestamp (ISO 8601)
store.logo.mimeType	Text	MIME type of the asset
store.logo.size	Number	Asset size in bytes
store.logo.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.logo.meta.thumbnails[]	List	Generated thumbnail variants
store.logo.status	Text	Asset status
store.image	Object	Asset payload in VirtualStore events
store.image.id	Text	Asset ID
store.image.name	Text	Asset name
store.image.url	Text	Asset URL
store.image.createdAt	Text	Created at timestamp (ISO 8601)
store.image.mimeType	Text	MIME type of the asset
store.image.size	Number	Asset size in bytes
store.image.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.image.meta.thumbnails[]	List	Generated thumbnail variants
store.image.status	Text	Asset status
hosts[]	List	Hosts of the direct session (the single item is null when no host is assigned)
hosts[].id	Text	Host ID
hosts[].email	Text	Host email
hosts[].fullName	Text	Host full name
hosts[].profile	Object	Host profile payload in VirtualStore events
hosts[].profile.introduction	Text	Host introduction
hosts[].profile.position	Text	Host position
hosts[].profile.url	Text	Host profile URL
hosts[].profile.twitter	Text	Host Twitter handle
hosts[].profile.facebook	Text	Host Facebook profile
hosts[].profile.instagram	Text	Host Instagram profile
hosts[].profile.nickname	Text	Host nickname
hosts[].profile.avatar	Object	Asset payload in VirtualStore events
hosts[].profile.avatar.id	Text	Asset ID
hosts[].profile.avatar.name	Text	Asset name
hosts[].profile.avatar.url	Text	Asset URL
hosts[].profile.avatar.createdAt	Text	Created at timestamp (ISO 8601)
hosts[].profile.avatar.mimeType	Text	MIME type of the asset
hosts[].profile.avatar.size	Number	Asset size in bytes
hosts[].profile.avatar.meta	Object	Asset metadata (optional; e.g. thumbnails)
hosts[].profile.avatar.status	Text	Asset status
hosts[].displayName	Text	Host display name

Direct Session Started

Triggered when a direct session is started

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, session is $trigger.output.session.

{
  "session": {},
  "guests": [
    {
      "id": "string",
      "familyName": "string",
      "firstName": "string",
      "familyFurigana": "string",
      "firstFurigana": "string",
      "familyKatakana": "string",
      "firstKatakana": "string",
      "phoneNumber": "string",
      "line": {},
      "email": "string",
      "hashId": "string",
      "visitorId": "string",
      "isBooker": false,
      "identity": "string",
      "fullName": "string",
      "externalId": "string",
      "webId": "string",
      "isSurveyEnabled": false
    }
  ],
  "store": {},
  "hosts": [
    {
      "id": "string",
      "email": "string",
      "fullName": "string",
      "profile": {},
      "displayName": "string"
    }
  ]
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
session	Object	Direct session payload in VirtualStore events
session.id	Text	Direct session ID
session.oid	Text	Organization ID of the direct session
session.status	Text	Direct session status
session.type	Text	Session type (always directsession)
session.startAt	Text	Direct session start timestamp (ISO 8601)
session.endAt	Text	Direct session end timestamp (ISO 8601), empty until the session ends
session.createdAt	Text	Created at timestamp (ISO 8601)
session.updatedAt	Text	Updated at timestamp (ISO 8601)
session.isPrivate	Yes / No	Whether the direct session is private
session.isTest	Yes / No	Whether this is a test direct session
session.urlType	Text	URL type used when creating the direct session
session.isRecorded	Yes / No	Whether the direct session is recorded
session.responses[]	List	Survey results of all guests for the direct session; empty until a guest submits the survey
session.responses[].id	Text	Answer ID
session.responses[].surveyId	Text	Survey ID
session.responses[].resourceType	Text	Response resource type (guest | identity)
session.responses[].resourceId	Text	Response resource ID (guest ID)
session.responses[].responseId	Text	Response ID
session.responses[].questionId	Text	Question ID
session.responses[].questionTitle	Text	Question title
session.responses[].questionExplanation	Text	Question explanation
session.responses[].questionType	Text	Question field type
session.responses[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.responses[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.responses[].branchCode	Text	Parsed branch code from answer
session.responses[].otherAnswer	Text	Other answer text when applicable
session.responses[].assets[]	List	Assets attached to the answer
session.responses[].assets[].id	Text	Asset ID
session.responses[].assets[].name	Text	Asset name
session.responses[].assets[].url	Text	Asset URL
session.responses[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.responses[].assets[].mimeType	Text	MIME type of the asset
session.responses[].assets[].size	Number	Asset size in bytes
session.responses[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.responses[].assets[].status	Text	Asset status
session.answers[]	List	Hearing form answers for the direct session
session.answers[].id	Text	Answer ID
session.answers[].surveyId	Text	Survey ID
session.answers[].resourceType	Text	Response resource type (guest | identity)
session.answers[].resourceId	Text	Response resource ID (guest ID)
session.answers[].responseId	Text	Response ID
session.answers[].questionId	Text	Question ID
session.answers[].questionTitle	Text	Question title
session.answers[].questionExplanation	Text	Question explanation
session.answers[].questionType	Text	Question field type
session.answers[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.answers[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.answers[].branchCode	Text	Parsed branch code from answer
session.answers[].otherAnswer	Text	Other answer text when applicable
session.answers[].assets[]	List	Assets attached to the answer
session.answers[].assets[].id	Text	Asset ID
session.answers[].assets[].name	Text	Asset name
session.answers[].assets[].url	Text	Asset URL
session.answers[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.answers[].assets[].mimeType	Text	MIME type of the asset
session.answers[].assets[].size	Number	Asset size in bytes
session.answers[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.answers[].assets[].status	Text	Asset status
session.cancelledReason	Text	Reason for cancellation
session.cancelledBy	Text	Who cancelled the direct session
guests[]	List	Guests of the direct session
guests[].id	Text	Guest ID
guests[].familyName	Text	Family name of guest
guests[].firstName	Text	First name of guest
guests[].familyFurigana	Text	Family name in furigana
guests[].firstFurigana	Text	First name in furigana
guests[].familyKatakana	Text	Family name in katakana
guests[].firstKatakana	Text	First name in katakana
guests[].phoneNumber	Text	Guest phone number
guests[].line	Object	LINE profile of a guest in VirtualStore events
guests[].line.id	Text	LINE user ID (with U prefix)
guests[].line.name	Text	LINE display name
guests[].line.avatar	Text	LINE avatar URL
guests[].line.isFriend	Yes / No	Whether the guest is a LINE friend
guests[].email	Text	Guest email
guests[].hashId	Text	Guest hashed ID
guests[].visitorId	Text	Visitor ID
guests[].isBooker	Yes / No	Whether this guest is the booker
guests[].identity	Text	Guest identity
guests[].fullName	Text	Full name of guest
guests[].externalId	Text	Guest external ID
guests[].webId	Text	Guest web ID
guests[].isSurveyEnabled	Yes / No	Whether survey is enabled for guest
store	Object	Store payload in VirtualStore events
store.id	Text	Store ID
store.name	Text	Store name
store.timezone	Text	Store timezone
store.logo	Object	Asset payload in VirtualStore events
store.logo.id	Text	Asset ID
store.logo.name	Text	Asset name
store.logo.url	Text	Asset URL
store.logo.createdAt	Text	Created at timestamp (ISO 8601)
store.logo.mimeType	Text	MIME type of the asset
store.logo.size	Number	Asset size in bytes
store.logo.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.logo.meta.thumbnails[]	List	Generated thumbnail variants
store.logo.status	Text	Asset status
store.image	Object	Asset payload in VirtualStore events
store.image.id	Text	Asset ID
store.image.name	Text	Asset name
store.image.url	Text	Asset URL
store.image.createdAt	Text	Created at timestamp (ISO 8601)
store.image.mimeType	Text	MIME type of the asset
store.image.size	Number	Asset size in bytes
store.image.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.image.meta.thumbnails[]	List	Generated thumbnail variants
store.image.status	Text	Asset status
hosts[]	List	Hosts of the direct session (the single item is null when no host is assigned)
hosts[].id	Text	Host ID
hosts[].email	Text	Host email
hosts[].fullName	Text	Host full name
hosts[].profile	Object	Host profile payload in VirtualStore events
hosts[].profile.introduction	Text	Host introduction
hosts[].profile.position	Text	Host position
hosts[].profile.url	Text	Host profile URL
hosts[].profile.twitter	Text	Host Twitter handle
hosts[].profile.facebook	Text	Host Facebook profile
hosts[].profile.instagram	Text	Host Instagram profile
hosts[].profile.nickname	Text	Host nickname
hosts[].profile.avatar	Object	Asset payload in VirtualStore events
hosts[].profile.avatar.id	Text	Asset ID
hosts[].profile.avatar.name	Text	Asset name
hosts[].profile.avatar.url	Text	Asset URL
hosts[].profile.avatar.createdAt	Text	Created at timestamp (ISO 8601)
hosts[].profile.avatar.mimeType	Text	MIME type of the asset
hosts[].profile.avatar.size	Number	Asset size in bytes
hosts[].profile.avatar.meta	Object	Asset metadata (optional; e.g. thumbnails)
hosts[].profile.avatar.status	Text	Asset status
hosts[].displayName	Text	Host display name

Direct Session Ended

Triggered when a direct session is ended

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, session is $trigger.output.session.

{
  "session": {},
  "guests": [
    {
      "id": "string",
      "familyName": "string",
      "firstName": "string",
      "familyFurigana": "string",
      "firstFurigana": "string",
      "familyKatakana": "string",
      "firstKatakana": "string",
      "phoneNumber": "string",
      "line": {},
      "email": "string",
      "hashId": "string",
      "visitorId": "string",
      "isBooker": false,
      "identity": "string",
      "fullName": "string",
      "externalId": "string",
      "webId": "string",
      "isSurveyEnabled": false
    }
  ],
  "store": {},
  "hosts": [
    {
      "id": "string",
      "email": "string",
      "fullName": "string",
      "profile": {},
      "displayName": "string"
    }
  ]
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
session	Object	Direct session payload in VirtualStore events
session.id	Text	Direct session ID
session.oid	Text	Organization ID of the direct session
session.status	Text	Direct session status
session.type	Text	Session type (always directsession)
session.startAt	Text	Direct session start timestamp (ISO 8601)
session.endAt	Text	Direct session end timestamp (ISO 8601), empty until the session ends
session.createdAt	Text	Created at timestamp (ISO 8601)
session.updatedAt	Text	Updated at timestamp (ISO 8601)
session.isPrivate	Yes / No	Whether the direct session is private
session.isTest	Yes / No	Whether this is a test direct session
session.urlType	Text	URL type used when creating the direct session
session.isRecorded	Yes / No	Whether the direct session is recorded
session.responses[]	List	Survey results of all guests for the direct session; empty until a guest submits the survey
session.responses[].id	Text	Answer ID
session.responses[].surveyId	Text	Survey ID
session.responses[].resourceType	Text	Response resource type (guest | identity)
session.responses[].resourceId	Text	Response resource ID (guest ID)
session.responses[].responseId	Text	Response ID
session.responses[].questionId	Text	Question ID
session.responses[].questionTitle	Text	Question title
session.responses[].questionExplanation	Text	Question explanation
session.responses[].questionType	Text	Question field type
session.responses[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.responses[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.responses[].branchCode	Text	Parsed branch code from answer
session.responses[].otherAnswer	Text	Other answer text when applicable
session.responses[].assets[]	List	Assets attached to the answer
session.responses[].assets[].id	Text	Asset ID
session.responses[].assets[].name	Text	Asset name
session.responses[].assets[].url	Text	Asset URL
session.responses[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.responses[].assets[].mimeType	Text	MIME type of the asset
session.responses[].assets[].size	Number	Asset size in bytes
session.responses[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.responses[].assets[].status	Text	Asset status
session.answers[]	List	Hearing form answers for the direct session
session.answers[].id	Text	Answer ID
session.answers[].surveyId	Text	Survey ID
session.answers[].resourceType	Text	Response resource type (guest | identity)
session.answers[].resourceId	Text	Response resource ID (guest ID)
session.answers[].responseId	Text	Response ID
session.answers[].questionId	Text	Question ID
session.answers[].questionTitle	Text	Question title
session.answers[].questionExplanation	Text	Question explanation
session.answers[].questionType	Text	Question field type
session.answers[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.answers[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.answers[].branchCode	Text	Parsed branch code from answer
session.answers[].otherAnswer	Text	Other answer text when applicable
session.answers[].assets[]	List	Assets attached to the answer
session.answers[].assets[].id	Text	Asset ID
session.answers[].assets[].name	Text	Asset name
session.answers[].assets[].url	Text	Asset URL
session.answers[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.answers[].assets[].mimeType	Text	MIME type of the asset
session.answers[].assets[].size	Number	Asset size in bytes
session.answers[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.answers[].assets[].status	Text	Asset status
session.cancelledReason	Text	Reason for cancellation
session.cancelledBy	Text	Who cancelled the direct session
guests[]	List	Guests of the direct session
guests[].id	Text	Guest ID
guests[].familyName	Text	Family name of guest
guests[].firstName	Text	First name of guest
guests[].familyFurigana	Text	Family name in furigana
guests[].firstFurigana	Text	First name in furigana
guests[].familyKatakana	Text	Family name in katakana
guests[].firstKatakana	Text	First name in katakana
guests[].phoneNumber	Text	Guest phone number
guests[].line	Object	LINE profile of a guest in VirtualStore events
guests[].line.id	Text	LINE user ID (with U prefix)
guests[].line.name	Text	LINE display name
guests[].line.avatar	Text	LINE avatar URL
guests[].line.isFriend	Yes / No	Whether the guest is a LINE friend
guests[].email	Text	Guest email
guests[].hashId	Text	Guest hashed ID
guests[].visitorId	Text	Visitor ID
guests[].isBooker	Yes / No	Whether this guest is the booker
guests[].identity	Text	Guest identity
guests[].fullName	Text	Full name of guest
guests[].externalId	Text	Guest external ID
guests[].webId	Text	Guest web ID
guests[].isSurveyEnabled	Yes / No	Whether survey is enabled for guest
store	Object	Store payload in VirtualStore events
store.id	Text	Store ID
store.name	Text	Store name
store.timezone	Text	Store timezone
store.logo	Object	Asset payload in VirtualStore events
store.logo.id	Text	Asset ID
store.logo.name	Text	Asset name
store.logo.url	Text	Asset URL
store.logo.createdAt	Text	Created at timestamp (ISO 8601)
store.logo.mimeType	Text	MIME type of the asset
store.logo.size	Number	Asset size in bytes
store.logo.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.logo.meta.thumbnails[]	List	Generated thumbnail variants
store.logo.status	Text	Asset status
store.image	Object	Asset payload in VirtualStore events
store.image.id	Text	Asset ID
store.image.name	Text	Asset name
store.image.url	Text	Asset URL
store.image.createdAt	Text	Created at timestamp (ISO 8601)
store.image.mimeType	Text	MIME type of the asset
store.image.size	Number	Asset size in bytes
store.image.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.image.meta.thumbnails[]	List	Generated thumbnail variants
store.image.status	Text	Asset status
hosts[]	List	Hosts of the direct session (the single item is null when no host is assigned)
hosts[].id	Text	Host ID
hosts[].email	Text	Host email
hosts[].fullName	Text	Host full name
hosts[].profile	Object	Host profile payload in VirtualStore events
hosts[].profile.introduction	Text	Host introduction
hosts[].profile.position	Text	Host position
hosts[].profile.url	Text	Host profile URL
hosts[].profile.twitter	Text	Host Twitter handle
hosts[].profile.facebook	Text	Host Facebook profile
hosts[].profile.instagram	Text	Host Instagram profile
hosts[].profile.nickname	Text	Host nickname
hosts[].profile.avatar	Object	Asset payload in VirtualStore events
hosts[].profile.avatar.id	Text	Asset ID
hosts[].profile.avatar.name	Text	Asset name
hosts[].profile.avatar.url	Text	Asset URL
hosts[].profile.avatar.createdAt	Text	Created at timestamp (ISO 8601)
hosts[].profile.avatar.mimeType	Text	MIME type of the asset
hosts[].profile.avatar.size	Number	Asset size in bytes
hosts[].profile.avatar.meta	Object	Asset metadata (optional; e.g. thumbnails)
hosts[].profile.avatar.status	Text	Asset status
hosts[].displayName	Text	Host display name

Direct Session Cancelled

Triggered when a direct session is cancelled

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, session is $trigger.output.session.

{
  "session": {},
  "guests": [
    {
      "id": "string",
      "familyName": "string",
      "firstName": "string",
      "familyFurigana": "string",
      "firstFurigana": "string",
      "familyKatakana": "string",
      "firstKatakana": "string",
      "phoneNumber": "string",
      "line": {},
      "email": "string",
      "hashId": "string",
      "visitorId": "string",
      "isBooker": false,
      "identity": "string",
      "fullName": "string",
      "externalId": "string",
      "webId": "string",
      "isSurveyEnabled": false
    }
  ],
  "store": {},
  "hosts": [
    {
      "id": "string",
      "email": "string",
      "fullName": "string",
      "profile": {},
      "displayName": "string"
    }
  ]
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
session	Object	Direct session payload in VirtualStore events
session.id	Text	Direct session ID
session.oid	Text	Organization ID of the direct session
session.status	Text	Direct session status
session.type	Text	Session type (always directsession)
session.startAt	Text	Direct session start timestamp (ISO 8601)
session.endAt	Text	Direct session end timestamp (ISO 8601), empty until the session ends
session.createdAt	Text	Created at timestamp (ISO 8601)
session.updatedAt	Text	Updated at timestamp (ISO 8601)
session.isPrivate	Yes / No	Whether the direct session is private
session.isTest	Yes / No	Whether this is a test direct session
session.urlType	Text	URL type used when creating the direct session
session.isRecorded	Yes / No	Whether the direct session is recorded
session.responses[]	List	Survey results of all guests for the direct session; empty until a guest submits the survey
session.responses[].id	Text	Answer ID
session.responses[].surveyId	Text	Survey ID
session.responses[].resourceType	Text	Response resource type (guest | identity)
session.responses[].resourceId	Text	Response resource ID (guest ID)
session.responses[].responseId	Text	Response ID
session.responses[].questionId	Text	Question ID
session.responses[].questionTitle	Text	Question title
session.responses[].questionExplanation	Text	Question explanation
session.responses[].questionType	Text	Question field type
session.responses[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.responses[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.responses[].branchCode	Text	Parsed branch code from answer
session.responses[].otherAnswer	Text	Other answer text when applicable
session.responses[].assets[]	List	Assets attached to the answer
session.responses[].assets[].id	Text	Asset ID
session.responses[].assets[].name	Text	Asset name
session.responses[].assets[].url	Text	Asset URL
session.responses[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.responses[].assets[].mimeType	Text	MIME type of the asset
session.responses[].assets[].size	Number	Asset size in bytes
session.responses[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.responses[].assets[].status	Text	Asset status
session.answers[]	List	Hearing form answers for the direct session
session.answers[].id	Text	Answer ID
session.answers[].surveyId	Text	Survey ID
session.answers[].resourceType	Text	Response resource type (guest | identity)
session.answers[].resourceId	Text	Response resource ID (guest ID)
session.answers[].responseId	Text	Response ID
session.answers[].questionId	Text	Question ID
session.answers[].questionTitle	Text	Question title
session.answers[].questionExplanation	Text	Question explanation
session.answers[].questionType	Text	Question field type
session.answers[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.answers[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.answers[].branchCode	Text	Parsed branch code from answer
session.answers[].otherAnswer	Text	Other answer text when applicable
session.answers[].assets[]	List	Assets attached to the answer
session.answers[].assets[].id	Text	Asset ID
session.answers[].assets[].name	Text	Asset name
session.answers[].assets[].url	Text	Asset URL
session.answers[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.answers[].assets[].mimeType	Text	MIME type of the asset
session.answers[].assets[].size	Number	Asset size in bytes
session.answers[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.answers[].assets[].status	Text	Asset status
session.cancelledReason	Text	Reason for cancellation
session.cancelledBy	Text	Who cancelled the direct session
guests[]	List	Guests of the direct session
guests[].id	Text	Guest ID
guests[].familyName	Text	Family name of guest
guests[].firstName	Text	First name of guest
guests[].familyFurigana	Text	Family name in furigana
guests[].firstFurigana	Text	First name in furigana
guests[].familyKatakana	Text	Family name in katakana
guests[].firstKatakana	Text	First name in katakana
guests[].phoneNumber	Text	Guest phone number
guests[].line	Object	LINE profile of a guest in VirtualStore events
guests[].line.id	Text	LINE user ID (with U prefix)
guests[].line.name	Text	LINE display name
guests[].line.avatar	Text	LINE avatar URL
guests[].line.isFriend	Yes / No	Whether the guest is a LINE friend
guests[].email	Text	Guest email
guests[].hashId	Text	Guest hashed ID
guests[].visitorId	Text	Visitor ID
guests[].isBooker	Yes / No	Whether this guest is the booker
guests[].identity	Text	Guest identity
guests[].fullName	Text	Full name of guest
guests[].externalId	Text	Guest external ID
guests[].webId	Text	Guest web ID
guests[].isSurveyEnabled	Yes / No	Whether survey is enabled for guest
store	Object	Store payload in VirtualStore events
store.id	Text	Store ID
store.name	Text	Store name
store.timezone	Text	Store timezone
store.logo	Object	Asset payload in VirtualStore events
store.logo.id	Text	Asset ID
store.logo.name	Text	Asset name
store.logo.url	Text	Asset URL
store.logo.createdAt	Text	Created at timestamp (ISO 8601)
store.logo.mimeType	Text	MIME type of the asset
store.logo.size	Number	Asset size in bytes
store.logo.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.logo.meta.thumbnails[]	List	Generated thumbnail variants
store.logo.status	Text	Asset status
store.image	Object	Asset payload in VirtualStore events
store.image.id	Text	Asset ID
store.image.name	Text	Asset name
store.image.url	Text	Asset URL
store.image.createdAt	Text	Created at timestamp (ISO 8601)
store.image.mimeType	Text	MIME type of the asset
store.image.size	Number	Asset size in bytes
store.image.meta	Object	Asset metadata (optional; e.g. thumbnails)
store.image.meta.thumbnails[]	List	Generated thumbnail variants
store.image.status	Text	Asset status
hosts[]	List	Hosts of the direct session (the single item is null when no host is assigned)
hosts[].id	Text	Host ID
hosts[].email	Text	Host email
hosts[].fullName	Text	Host full name
hosts[].profile	Object	Host profile payload in VirtualStore events
hosts[].profile.introduction	Text	Host introduction
hosts[].profile.position	Text	Host position
hosts[].profile.url	Text	Host profile URL
hosts[].profile.twitter	Text	Host Twitter handle
hosts[].profile.facebook	Text	Host Facebook profile
hosts[].profile.instagram	Text	Host Instagram profile
hosts[].profile.nickname	Text	Host nickname
hosts[].profile.avatar	Object	Asset payload in VirtualStore events
hosts[].profile.avatar.id	Text	Asset ID
hosts[].profile.avatar.name	Text	Asset name
hosts[].profile.avatar.url	Text	Asset URL
hosts[].profile.avatar.createdAt	Text	Created at timestamp (ISO 8601)
hosts[].profile.avatar.mimeType	Text	MIME type of the asset
hosts[].profile.avatar.size	Number	Asset size in bytes
hosts[].profile.avatar.meta	Object	Asset metadata (optional; e.g. thumbnails)
hosts[].profile.avatar.status	Text	Asset status
hosts[].displayName	Text	Host display name

Survey Response Created

Triggered when a guest submits a survey response for a reservation or direct session

Settings

No settings.

Output

Later steps use this data through Current Trigger in the $ picker. For example, session is $trigger.output.session.

{
  "session": {},
  "guests": [
    {
      "id": "string",
      "familyName": "string",
      "firstName": "string",
      "familyFurigana": "string",
      "firstFurigana": "string",
      "familyKatakana": "string",
      "firstKatakana": "string",
      "phoneNumber": "string",
      "line": {},
      "email": "string",
      "hashId": "string",
      "visitorId": "string",
      "isBooker": false,
      "identity": "string",
      "fullName": "string",
      "externalId": "string",
      "webId": "string",
      "isSurveyEnabled": false
    }
  ],
  "response": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
session	Object	Session payload in VirtualStore reservation and survey response events
session.id	Text	Session ID
session.oid	Text	Organization ID of the session
session.flow	Text	Reservation flow
session.status	Text	Session status
session.type	Text	Session type (e.g. online, offline)
session.startAt	Text	Session start timestamp (ISO 8601)
session.endAt	Text	Session end timestamp (ISO 8601)
session.createdAt	Text	Created at timestamp (ISO 8601)
session.updatedAt	Text	Updated at timestamp (ISO 8601)
session.isPrivate	Yes / No	Whether the session is private
session.isRestorable	Yes / No	Whether the reservation can be restored
session.isTest	Yes / No	Whether this is a test session
session.isChangeable	Yes / No	Whether the reservation can be changed
session.isHostSelection	Yes / No	Whether host selection is enabled
session.urlType	Text	URL type used when creating the session
session.rescheduledAt	Text	Rescheduled at timestamp (ISO 8601)
session.originalHostId	Text	Original host ID before reschedule
session.isRecorded	Yes / No	Whether the session is recorded
session.duration	Object	Duration detail of a reservation session in VirtualStore events
session.duration.name	Text	Duration name
session.duration.duration	Number	Duration in minutes
session.duration.description	Text	Duration description
session.duration.bufferTime	Number	Buffer time in minutes
session.duration.membership	Text	Membership associated with duration
session.duration.memberMode	Text	Member mode associated with duration
session.responses[]	List	Survey results / responses for the session. Holds every survey response on the session (all guests), not only the newest one; group by responseId / resourceId
session.responses[].id	Text	Answer ID
session.responses[].surveyId	Text	Survey ID
session.responses[].resourceType	Text	Response resource type (guest | identity)
session.responses[].resourceId	Text	Response resource ID (guest ID)
session.responses[].responseId	Text	Response ID
session.responses[].questionId	Text	Question ID
session.responses[].questionTitle	Text	Question title
session.responses[].questionExplanation	Text	Question explanation
session.responses[].questionType	Text	Question field type
session.responses[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.responses[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.responses[].branchCode	Text	Parsed branch code from answer
session.responses[].otherAnswer	Text	Other answer text when applicable
session.responses[].assets[]	List	Assets attached to the answer
session.responses[].assets[].id	Text	Asset ID
session.responses[].assets[].name	Text	Asset name
session.responses[].assets[].url	Text	Asset URL
session.responses[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.responses[].assets[].mimeType	Text	MIME type of the asset
session.responses[].assets[].size	Number	Asset size in bytes
session.responses[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.responses[].assets[].status	Text	Asset status
session.answers[]	List	Hearing form answers for the session
session.answers[].id	Text	Answer ID
session.answers[].surveyId	Text	Survey ID
session.answers[].resourceType	Text	Response resource type (guest | identity)
session.answers[].resourceId	Text	Response resource ID (guest ID)
session.answers[].responseId	Text	Response ID
session.answers[].questionId	Text	Question ID
session.answers[].questionTitle	Text	Question title
session.answers[].questionExplanation	Text	Question explanation
session.answers[].questionType	Text	Question field type
session.answers[].isSatisfaction	Yes / No	Whether the question is a satisfaction question
session.answers[].answer	Any	Answer value: a string, a number (e.g. linear scale) or a list of strings (checkbox)
session.answers[].branchCode	Text	Parsed branch code from answer
session.answers[].otherAnswer	Text	Other answer text when applicable
session.answers[].assets[]	List	Assets attached to the answer
session.answers[].assets[].id	Text	Asset ID
session.answers[].assets[].name	Text	Asset name
session.answers[].assets[].url	Text	Asset URL
session.answers[].assets[].createdAt	Text	Created at timestamp (ISO 8601)
session.answers[].assets[].mimeType	Text	MIME type of the asset
session.answers[].assets[].size	Number	Asset size in bytes
session.answers[].assets[].meta	Object	Asset metadata (optional; e.g. thumbnails)
session.answers[].assets[].status	Text	Asset status
session.systemReadiness	Object	System readiness checks for a reservation session
session.systemReadiness.micro	Yes / No	Microphone readiness
session.systemReadiness.camera	Yes / No	Camera readiness
session.systemReadiness.browser	Yes / No	Browser readiness
session.systemReadiness.speaker	Yes / No	Speaker readiness
session.cancelledReason	Text	Reason for cancellation
session.cancelledBy	Text	Who cancelled the session
guests[]	List	Guests of the session
guests[].id	Text	Guest ID
guests[].familyName	Text	Family name of guest
guests[].firstName	Text	First name of guest
guests[].familyFurigana	Text	Family name in furigana
guests[].firstFurigana	Text	First name in furigana
guests[].familyKatakana	Text	Family name in katakana
guests[].firstKatakana	Text	First name in katakana
guests[].phoneNumber	Text	Guest phone number
guests[].line	Object	LINE profile of a guest in VirtualStore events
guests[].line.id	Text	LINE user ID (with U prefix)
guests[].line.name	Text	LINE display name
guests[].line.avatar	Text	LINE avatar URL
guests[].line.isFriend	Yes / No	Whether the guest is a LINE friend
guests[].email	Text	Guest email
guests[].hashId	Text	Guest hashed ID
guests[].visitorId	Text	Visitor ID
guests[].isBooker	Yes / No	Whether this guest is the booker
guests[].identity	Text	Guest identity
guests[].fullName	Text	Full name of guest
guests[].externalId	Text	Guest external ID
guests[].webId	Text	Guest web ID
guests[].isSurveyEnabled	Yes / No	Whether survey is enabled for guest
response	Object	Survey response that triggered a VirtualStore survey event
response.responseId	Text	Response ID; matches responseId on the items in session.responses
response.surveyId	Text	Survey ID
response.resourceType	Text	Who submitted the response: guest, identity or user
response.resourceId	Text	ID of who submitted the response (the guest ID when resourceType is guest)
response.targetType	Text	Where the response was submitted: store.reservation.survey for a reservation, store.directsession.survey for a direct session
response.targetId	Text	ID of the reservation or direct session
response.createdAt	Text	First submission timestamp (ISO 8601); unchanged when the guest resubmits
response.isUpdated	Yes / No	Whether the guest resubmitted the survey and the existing response was updated

Actions

Steps this node can perform. Add one from Add a step, then pick the action.

List Reservations

Get a list of all reservations in the specific store

Settings

Field	Type	Required	Description
Store ID	Text	Yes	List reservations in the specific store
Host ID	Text		Filter by host ID
Status	Text		Filter by reservation status
Page	Number		Page number for pagination Default: 1
Per Page	Number		Number of items per page Default: 100

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "host_id": "string",
  "equipment_id": "string",
  "start_at": "string",
  "end_at": "string",
  "status": "string",
  "type": "string",
  "is_private": false,
  "num_by_guest": 0,
  "guests": [
    {
      "id": "string",
      "hash_id": "string",
      "family_name": "string",
      "first_name": "string",
      "family_furigana": "string",
      "first_furigana": "string",
      "family_katakana": "string",
      "first_katakana": "string",
      "email": "string",
      "note": "string",
      "phone_number": "string",
      "line": {
        "id": "string",
        "name": "string",
        "avatar": "string",
        "user_id": "string"
      },
      "status": "string",
      "resource_type": "string",
      "resource_id": "string",
      "external_id": "string",
      "is_survey_enabled": true
    }
  ],
  "host": {},
  "equipment": {},
  "duration": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Unique identifier for the reservation
host_id	Text	ID of the host
equipment_id	Text	ID of the equipment
start_at	Text	Start time of the reservation
end_at	Text	End time of the reservation
status	Text	Status of the reservation
type	Text	Type of the reservation
is_private	Yes / No	Whether the reservation is private
num_by_guest	Number	Number of guests in the reservation
guests[]	List	List of guests in the reservation
guests[].id	Text	Unique identifier for the guest
guests[].hash_id	Text	Guest hashed id
guests[].family_name	Text	Family name of guest
guests[].first_name	Text	First name of guest
guests[].family_furigana	Text	Family furigana format
guests[].first_furigana	Text	First furigana format
guests[].family_katakana	Text	Family katakana format
guests[].first_katakana	Text	First katakana format
guests[].email	Text	Guest email
guests[].note	Text	Guest note
guests[].phone_number	Text	Guest's phone number
guests[].line	Object	LINE profile
guests[].line.id	Text	Internal ID for LINE profile
guests[].line.name	Text	The LINE name of guest
guests[].line.avatar	Text	The LINE avatar
guests[].line.user_id	Text	External ID for LINE profile (LINE UID)
guests[].status	Text	The reservation status
guests[].resource_type	Text	The resource type
guests[].resource_id	Text	The resource id
guests[].external_id	Text	Guest external id
guests[].is_survey_enabled	Yes / No	Flag to enable survey
host	Object	Host information
equipment	Object	Equipment information
duration	Object	Duration information

Retrieve Reservation

Retrieve a reservation by ID

Settings

Field	Type	Required	Description
Reservation ID	Text	Yes	ID of the reservation

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "host_id": "string",
  "equipment_id": "string",
  "start_at": "string",
  "end_at": "string",
  "status": "string",
  "type": "string",
  "is_private": false,
  "num_by_guest": 0,
  "guests": [
    {
      "id": "string",
      "hash_id": "string",
      "family_name": "string",
      "first_name": "string",
      "family_furigana": "string",
      "first_furigana": "string",
      "family_katakana": "string",
      "first_katakana": "string",
      "email": "string",
      "note": "string",
      "phone_number": "string",
      "line": {
        "id": "string",
        "name": "string",
        "avatar": "string",
        "user_id": "string"
      },
      "status": "string",
      "resource_type": "string",
      "resource_id": "string",
      "external_id": "string",
      "is_survey_enabled": true
    }
  ],
  "host": {},
  "equipment": {},
  "duration": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Unique identifier for the reservation
host_id	Text	ID of the host
equipment_id	Text	ID of the equipment
start_at	Text	Start time of the reservation
end_at	Text	End time of the reservation
status	Text	Status of the reservation
type	Text	Type of the reservation
is_private	Yes / No	Whether the reservation is private
num_by_guest	Number	Number of guests in the reservation
guests[]	List	List of guests in the reservation
guests[].id	Text	Unique identifier for the guest
guests[].hash_id	Text	Guest hashed id
guests[].family_name	Text	Family name of guest
guests[].first_name	Text	First name of guest
guests[].family_furigana	Text	Family furigana format
guests[].first_furigana	Text	First furigana format
guests[].family_katakana	Text	Family katakana format
guests[].first_katakana	Text	First katakana format
guests[].email	Text	Guest email
guests[].note	Text	Guest note
guests[].phone_number	Text	Guest's phone number
guests[].line	Object	LINE profile
guests[].line.id	Text	Internal ID for LINE profile
guests[].line.name	Text	The LINE name of guest
guests[].line.avatar	Text	The LINE avatar
guests[].line.user_id	Text	External ID for LINE profile (LINE UID)
guests[].status	Text	The reservation status
guests[].resource_type	Text	The resource type
guests[].resource_id	Text	The resource id
guests[].external_id	Text	Guest external id
guests[].is_survey_enabled	Yes / No	Flag to enable survey
host	Object	Host information
equipment	Object	Equipment information
duration	Object	Duration information

Cancel Reservation

Cancel a reservation by ID

Settings

Field	Type	Required	Description
Reservation ID	Text	Yes	ID of the reservation

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "host_id": "string",
  "equipment_id": "string",
  "start_at": "string",
  "end_at": "string",
  "status": "string",
  "type": "string",
  "is_private": false,
  "num_by_guest": 0,
  "guests": [
    {
      "id": "string",
      "hash_id": "string",
      "family_name": "string",
      "first_name": "string",
      "family_furigana": "string",
      "first_furigana": "string",
      "family_katakana": "string",
      "first_katakana": "string",
      "email": "string",
      "note": "string",
      "phone_number": "string",
      "line": {
        "id": "string",
        "name": "string",
        "avatar": "string",
        "user_id": "string"
      },
      "status": "string",
      "resource_type": "string",
      "resource_id": "string",
      "external_id": "string",
      "is_survey_enabled": true
    }
  ],
  "host": {},
  "equipment": {},
  "duration": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Unique identifier for the reservation
host_id	Text	ID of the host
equipment_id	Text	ID of the equipment
start_at	Text	Start time of the reservation
end_at	Text	End time of the reservation
status	Text	Status of the reservation
type	Text	Type of the reservation
is_private	Yes / No	Whether the reservation is private
num_by_guest	Number	Number of guests in the reservation
guests[]	List	List of guests in the reservation
guests[].id	Text	Unique identifier for the guest
guests[].hash_id	Text	Guest hashed id
guests[].family_name	Text	Family name of guest
guests[].first_name	Text	First name of guest
guests[].family_furigana	Text	Family furigana format
guests[].first_furigana	Text	First furigana format
guests[].family_katakana	Text	Family katakana format
guests[].first_katakana	Text	First katakana format
guests[].email	Text	Guest email
guests[].note	Text	Guest note
guests[].phone_number	Text	Guest's phone number
guests[].line	Object	LINE profile
guests[].line.id	Text	Internal ID for LINE profile
guests[].line.name	Text	The LINE name of guest
guests[].line.avatar	Text	The LINE avatar
guests[].line.user_id	Text	External ID for LINE profile (LINE UID)
guests[].status	Text	The reservation status
guests[].resource_type	Text	The resource type
guests[].resource_id	Text	The resource id
guests[].external_id	Text	Guest external id
guests[].is_survey_enabled	Yes / No	Flag to enable survey
host	Object	Host information
equipment	Object	Equipment information
duration	Object	Duration information

Create Reservation

Create a new reservation

Settings

Field	Type	Required	Description
Store ID	Text	Yes	ID of the store
VS Organization ID	Text	Yes	VS ID of the organization
Start At	Text	Yes	Start at datetime
Duration ID	Text	Yes	The duration setting ID
Guest	Object	Yes	Guest information
Host ID	Text		Host id, if the reservation is being created with a specific host
Is Test	Yes / No		Flag for test mode Default: false
URL Type	Choice		URL source that user creates reservation from Options: Store, Host, Organization Default: store
Equipment ID	Text		Equipment id, required for the offline reservation
Type	Choice		Type of the reservation Options: Online, Offline Default: online
Creator ID	Text		Creator id, if the reservation is created by host
Response	Object		The hearing form response

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "host_id": "string",
  "equipment_id": "string",
  "start_at": "string",
  "end_at": "string",
  "status": "string",
  "type": "string",
  "is_private": false,
  "num_by_guest": 0,
  "guests": [
    {
      "id": "string",
      "hash_id": "string",
      "family_name": "string",
      "first_name": "string",
      "family_furigana": "string",
      "first_furigana": "string",
      "family_katakana": "string",
      "first_katakana": "string",
      "email": "string",
      "note": "string",
      "phone_number": "string",
      "line": {
        "id": "string",
        "name": "string",
        "avatar": "string",
        "user_id": "string"
      },
      "status": "string",
      "resource_type": "string",
      "resource_id": "string",
      "external_id": "string",
      "is_survey_enabled": true
    }
  ],
  "host": {},
  "equipment": {},
  "duration": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Unique identifier for the reservation
host_id	Text	ID of the host
equipment_id	Text	ID of the equipment
start_at	Text	Start time of the reservation
end_at	Text	End time of the reservation
status	Text	Status of the reservation
type	Text	Type of the reservation
is_private	Yes / No	Whether the reservation is private
num_by_guest	Number	Number of guests in the reservation
guests[]	List	List of guests in the reservation
guests[].id	Text	Unique identifier for the guest
guests[].hash_id	Text	Guest hashed id
guests[].family_name	Text	Family name of guest
guests[].first_name	Text	First name of guest
guests[].family_furigana	Text	Family furigana format
guests[].first_furigana	Text	First furigana format
guests[].family_katakana	Text	Family katakana format
guests[].first_katakana	Text	First katakana format
guests[].email	Text	Guest email
guests[].note	Text	Guest note
guests[].phone_number	Text	Guest's phone number
guests[].line	Object	LINE profile
guests[].line.id	Text	Internal ID for LINE profile
guests[].line.name	Text	The LINE name of guest
guests[].line.avatar	Text	The LINE avatar
guests[].line.user_id	Text	External ID for LINE profile (LINE UID)
guests[].status	Text	The reservation status
guests[].resource_type	Text	The resource type
guests[].resource_id	Text	The resource id
guests[].external_id	Text	Guest external id
guests[].is_survey_enabled	Yes / No	Flag to enable survey
host	Object	Host information
equipment	Object	Equipment information
duration	Object	Duration information

List Day Slots

Get a list of day slots that available for creating a new reservation

Settings

Field	Type	Required	Description
Store ID	Text	Yes	ID of the store
Type	Choice	Yes	Type of the reservation Options: Online, Offline
Duration	Number	Yes	Duration in minutes (15, 30, 45, 60)
Duration ID	Text		ID of the duration
From Date	Text		From date
To Date	Text		To date
Reservation ID	Text		Reservation ID in case changing the date time
Host ID	Text		ID of the host
Equipment ID	Text		ID of the equipment, This is for the offline reservation

Output

Later steps use this data by picking this step in the $ picker. For example, today is $.<step ID>.output.today.

{
  "today": "string",
  "days": [
    {
      "date": "string",
      "status": "string",
      "is_holiday": false,
      "hosts": [
        {}
      ]
    }
  ]
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
today	Text	Today
days[]	List	Days
days[].date	Text	Date
days[].status	Text	Status
days[].is_holiday	Yes / No	Is holiday
days[].hosts[]	List	Hosts
days[].hosts[].id	Text	Host ID
days[].hosts[].name	Text	Host name
days[].hosts[].status	Text	Host status
days[].hosts[].slots[]	List	Slots
days[].hosts[].slots[].start_time	Text	Start time
days[].hosts[].slots[].duration	Number	Duration

List Time Slots

Get a list of time slots that available for creating a new reservation

Settings

Field	Type	Required	Description
Store ID	Text	Yes	ID of the store
Duration	Number	Yes	Duration in minutes (15, 30, 45, 60)
Selected Day	Text	Yes	Selected Day (for example '2025-09-08')
Duration ID	Text		ID of the duration
Reservation ID	Text		ID of the reservation in case updating the reservation
Host ID	Text		ID of the host, if the reservation is being created with a specific host
Equipment ID	Text		ID of the equipment, This is for the offline reservation
Type	Choice		Type of the reservation Options: Online, Offline

Output

Later steps use this data by picking this step in the $ picker. For example, data[0].start_time is $.<step ID>.output.data[0].start_time.

{
  "data": [
    {
      "start_time": "string",
      "duration": 0
    }
  ]
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
data[]	List	Array of time slots with start time and duration
data[].start_time	Text	Start time
data[].duration	Number	Duration

List Stores

Get a list of all stores

Settings

Field	Type	Required	Description
Page	Number		Page number for pagination Default: 1
Per Page	Number		Number of items per page Default: 100

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "name": "string",
  "logo": {},
  "image": {},
  "address": {
    "address": "string",
    "latitude": 0,
    "longitude": 0
  },
  "settings": {},
  "working_days": {},
  "hash_id": "string",
  "reservation_url": "string",
  "time_zone": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Unique identifier for the store
name	Text	Name of the store
logo	Object	Store logo information
image	Object	Store image information
address	Object	Store address information
address.address	Text	Full address
address.latitude	Number	Latitude coordinate
address.longitude	Number	Longitude coordinate
settings	Object	Store settings
working_days	Object	Working days configuration
hash_id	Text	Hash identifier for the store
reservation_url	Text	URL for making reservations
time_zone	Text	Store time zone

Retrieve Store

Retrieve a store by ID

Settings

Field	Type	Required	Description
Resource ID	Text	Yes	ID of the store

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "name": "string",
  "logo": {},
  "image": {},
  "address": {
    "address": "string",
    "latitude": 0,
    "longitude": 0
  },
  "settings": {},
  "working_days": {},
  "hash_id": "string",
  "reservation_url": "string",
  "time_zone": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Unique identifier for the store
name	Text	Name of the store
logo	Object	Store logo information
image	Object	Store image information
address	Object	Store address information
address.address	Text	Full address
address.latitude	Number	Latitude coordinate
address.longitude	Number	Longitude coordinate
settings	Object	Store settings
working_days	Object	Working days configuration
hash_id	Text	Hash identifier for the store
reservation_url	Text	URL for making reservations
time_zone	Text	Store time zone

Retrieve Host

Retrieve a host by ID in the specific store

Settings

Field	Type	Required	Description
Host ID	Text	Yes	ID of the host in the specific store

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "email": "string",
  "full_name": "string",
  "display_name": "string",
  "role": "string",
  "profile": {
    "introduction": "string",
    "position": "string",
    "nickname": "string"
  },
  "number_of_scheduled_sessions": 0,
  "number_of_onhold_sessions": 0
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Unique identifier for the host
email	Text	Email address of the host
full_name	Text	Full name of the host
display_name	Text	Display name of the host
role	Text	Role of the host
profile	Object	Host profile information
profile.introduction	Text	Host introduction
profile.position	Text	Host position
profile.nickname	Text	Host nickname
number_of_scheduled_sessions	Number	Number of scheduled sessions
number_of_onhold_sessions	Number	Number of sessions on hold

Create Store

Create a new store

Settings

Field	Type	Required	Description
Name	Text	Yes	Name of the store
Brand	Text		Brand of the store, only use for the KAO organization

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "name": "string",
  "logo": {},
  "image": {},
  "address": {
    "address": "string",
    "latitude": 0,
    "longitude": 0
  },
  "settings": {},
  "working_days": {},
  "hash_id": "string",
  "reservation_url": "string",
  "time_zone": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Unique identifier for the store
name	Text	Name of the store
logo	Object	Store logo information
image	Object	Store image information
address	Object	Store address information
address.address	Text	Full address
address.latitude	Number	Latitude coordinate
address.longitude	Number	Longitude coordinate
settings	Object	Store settings
working_days	Object	Working days configuration
hash_id	Text	Hash identifier for the store
reservation_url	Text	URL for making reservations
time_zone	Text	Store time zone

Update Store Host

Update a host by ID in the specific store

Settings

Field	Type	Required	Description
Store Host ID	Text	Yes	ID of the host in the specific store
Is Available	Yes / No		Can be assigned Default: false
Is Publish Name Card In Session	Yes / No		Show hide name card in session room Default: true
Is Publish Name Card In Private URL	Yes / No		Show hide name card in private URL Default: true
Is Available Direct Session	Yes / No		Available for direct session Default: false
Is Available Offline	Yes / No		Available for offline session Default: false
LIFF ID	Text		LIFF ID for the host
LIFF Offline ID	Text		LIFF offline ID for the host
Direct Session Settings	Object		Direct session settings for the host
Direct Session List Sort	Text		Sort option for direct session list
Online Is Visible	Yes / No		Whether the host is visible for online sessions
Offline Is Visible	Yes / No		Whether the host is visible for offline sessions
Direct Session Is Visible	Yes / No		Whether the host is visible for direct sessions
Offline Index	Number		Index for offline session ordering Default: 0
Online Index	Number		Index for online session ordering Default: 0
Direct Session Index	Number		Index for direct session ordering Default: 0

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "email": "string",
  "full_name": "string",
  "display_name": "string",
  "role": "string",
  "profile": {
    "introduction": "string",
    "position": "string",
    "nickname": "string"
  },
  "number_of_scheduled_sessions": 0,
  "number_of_onhold_sessions": 0
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Unique identifier for the host
email	Text	Email address of the host
full_name	Text	Full name of the host
display_name	Text	Display name of the host
role	Text	Role of the host
profile	Object	Host profile information
profile.introduction	Text	Host introduction
profile.position	Text	Host position
profile.nickname	Text	Host nickname
number_of_scheduled_sessions	Number	Number of scheduled sessions
number_of_onhold_sessions	Number	Number of sessions on hold

List Store Durations

Get a list of all durations in the specific store

Settings

Field	Type	Required	Description
Store ID	Text	Yes	ID of the store
Type	Choice		Type of duration Options: Online, Offline

Output

Later steps use this data by picking this step in the $ picker. For example, [0].id is $.<step ID>.output.[0].id.

[
  {
    "id": "string",
    "name": "string",
    "type": "online",
    "duration": 0,
    "description": "string",
    "survey_id": "string",
    "by_host_survey_id": "string",
    "created_at": "string",
    "updated_at": "string",
    "image_id": "string",
    "image": {},
    "reception": {
      "enabled": false,
      "from_date": "string",
      "to_date": "string",
      "offset_day": 0,
      "offset_hour": 0,
      "limit_day": 7,
      "limit_hour": 0
    }
  }
]

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Unique identifier for the duration
name	Text	The duration name
type	Text	The duration type
duration	Number	The duration in minutes
description	Text	Duration description
survey_id	Text	The survey ID
by_host_survey_id	Text	The survey ID (by host)
created_at	Text	Created at datetime
updated_at	Text	Updated at datetime
image_id	Text	The duration image ID
image	Any
image.id	Text	Asset id
image.name	Text	File name
image.mime_type	Text	MIME Type
image.size	Number	Size of file
image.path	Text	URL of file
image.resource_type	Text	One of resource type defined in settings SUPPORTED_ASSET_RESOURCE_TYPE
image.resource_id	Text	Resource Id
image.index	Number	Index of asset in the list
image.created_at	Text	Created at datetime
reception	Object	Reception time setting
reception.enabled	Yes / No	Enable/Disable reception time for duration
reception.from_date	Text	The from-date for booking a reservation
reception.to_date	Text	The to-date for booking a reservation
reception.offset_day	Number	Reservation offset in day
reception.offset_hour	Number	Reservation offset in hour
reception.limit_day	Number	Reservation limit in day
reception.limit_hour	Number	Reservation limit in hour

Update Store Duration

Update a duration in the specific store

Settings

Field	Type	Required	Description
Store ID	Text	Yes	ID of the store
Durations	List		List of durations to update

Output

Later steps use this data by picking this step in the $ picker. For example, response.message is $.<step ID>.output.response.message.

{
  "response": {
    "message": "Durations updated successfully"
  }
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
response	Object	Result reported by the VirtualStore API
response.message	Text	Result message, e.g. Durations updated successfully

List Surveys

Get a list of all surveys in the specific store

Settings

Field	Type	Required	Description
Store ID	Text	Yes	ID of the store

Output

Later steps use this data by picking this step in the $ picker. For example, [0].id is $.<step ID>.output.[0].id.

[
  {
    "id": "string",
    "title": "string",
    "description": "string",
    "enabled_for": "reservation,directsession",
    "is_survey": false,
    "resource_type": "string",
    "questions": [
      {
        "id": "string",
        "type": "string",
        "placeholder": "string",
        "question": "string",
        "explanation": "string",
        "options": [],
        "validations": [],
        "order": 0,
        "has_other": false,
        "is_satisfaction": false,
        "is_image_option": false,
        "columns": 1,
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "is_editable": true,
    "created_at": "string",
    "updated_at": "string"
  }
]

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Survey ID
title	Text	The survey title
description	Text	The survey description
enabled_for	Text	The flag to enable or disable
is_survey	Yes / No	The survey flag
resource_type	Text	The survey resource type
questions[]	List	The survey question list
questions[].id	Text	The question ID
questions[].type	Text	The question type
questions[].placeholder	Text	The placeholder for input|textarea
questions[].question	Text	The question content
questions[].explanation	Text	Question explanation
questions[].options[]	List	The options for radio|checkbox|dropdown|linear_scale
questions[].options[].value	Text	Option value
questions[].options[].asset_id	Text	Asset for image option
questions[].options[].order	Text	Order for the satisfaction question
questions[].validations[]	List	The input validation
questions[].order	Number	The question order
questions[].has_other	Yes / No	The other option flag for options
questions[].is_satisfaction	Yes / No	The question is static satisfaction question or not
questions[].is_image_option	Yes / No	Flag this question contains image in options
questions[].columns	Number	The column's number for checkbox|radio
questions[].created_at	Text	Created at datetime
questions[].updated_at	Text	Updated at datetime
is_editable	Yes / No	The survey is editable
created_at	Text	Created at datetime
updated_at	Text	Updated at datetime

Retrieve Survey

Retrieve a survey by ID

Settings

Field	Type	Required	Description
Survey ID	Text	Yes	ID of the survey

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "title": "string",
  "description": "string",
  "enabled_for": "reservation,directsession",
  "is_survey": false,
  "resource_type": "string",
  "questions": [
    {
      "id": "string",
      "type": "string",
      "placeholder": "string",
      "question": "string",
      "explanation": "string",
      "options": [
        {}
      ],
      "validations": [
        {}
      ],
      "order": 0,
      "has_other": false,
      "is_satisfaction": false,
      "is_image_option": false,
      "columns": 1,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "is_editable": true,
  "created_at": "string",
  "updated_at": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Survey ID
title	Text	The survey title
description	Text	The survey description
enabled_for	Text	The flag to enable or disable
is_survey	Yes / No	The survey flag
resource_type	Text	The survey resource type
questions[]	List	The survey question list
questions[].id	Text	The question ID
questions[].type	Text	The question type
questions[].placeholder	Text	The placeholder for input|textarea
questions[].question	Text	The question content
questions[].explanation	Text	Question explanation
questions[].options[]	List	The options for radio|checkbox|dropdown|linear_scale
questions[].options[].value	Text	Option value
questions[].options[].asset_id	Text	Asset for image option
questions[].options[].order	Text	Order for the satisfaction question
questions[].validations[]	List	The input validation
questions[].order	Number	The question order
questions[].has_other	Yes / No	The other option flag for options
questions[].is_satisfaction	Yes / No	The question is static satisfaction question or not
questions[].is_image_option	Yes / No	Flag this question contains image in options
questions[].columns	Number	The column's number for checkbox|radio
questions[].created_at	Text	Created at datetime
questions[].updated_at	Text	Updated at datetime
is_editable	Yes / No	The survey is editable
created_at	Text	Created at datetime
updated_at	Text	Updated at datetime

List Hosts

Get a list of all hosts in the specific store

Settings

Field	Type	Required	Description
Role	Text		Filter by host role
Page	Number		Page number for pagination Default: 1
Per Page	Number		Number of items per page Default: 100

Output

Later steps use this data by picking this step in the $ picker. For example, [0].id is $.<step ID>.output.[0].id.

[
  {
    "id": "string",
    "email": "string",
    "full_name": "string",
    "display_name": "string",
    "role": "string",
    "profile": {
      "introduction": "string",
      "position": "string",
      "nickname": "string"
    },
    "number_of_scheduled_sessions": 0,
    "number_of_onhold_sessions": 0
  }
]

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	Unique identifier for the host
email	Text	Email address of the host
full_name	Text	Full name of the host
display_name	Text	Display name of the host
role	Text	Role of the host
profile	Object	Host profile information
profile.introduction	Text	Host introduction
profile.position	Text	Host position
profile.nickname	Text	Host nickname
number_of_scheduled_sessions	Number	Number of scheduled sessions
number_of_onhold_sessions	Number	Number of sessions on hold

List Direct Sessions

Get a list of all direct sessions in the specific store

Settings

Field	Type	Required	Description
Store ID	Text	Yes	ID of the store
Page	Number		Page number for pagination Default: 3
Sort	Text		Sort option for direct session list Default: -created_at
Per Page	Number		Number of items per page Default: 100

Output

Later steps use this data by picking this step in the $ picker. For example, [0].id is $.<step ID>.output.[0].id.

[
  {
    "id": "string",
    "host_id": "string",
    "start_at": "string",
    "end_at": "string",
    "status": "created",
    "created_at": "string",
    "updated_at": "string",
    "hash_id": "string",
    "utm_source": "string",
    "is_test": false,
    "is_private": false,
    "is_blocked_by": "string",
    "url_type": "string",
    "num_by_guest": 1,
    "is_recorded": false,
    "guests": [
      {
        "family_name": "string",
        "first_name": "string",
        "family_furigana": "string",
        "first_furigana": "string",
        "family_katakana": "string",
        "first_katakana": "string",
        "email": "string",
        "phone_number": "string",
        "external_id": "string",
        "web_id": "string",
        "hash_id": "string",
        "is_booker": false,
        "visitor_id": "string",
        "identity": 0,
        "attendee": {},
        "full_name": "string",
        "id": "string",
        "is_survey_enabled": true
      }
    ],
    "host": {},
    "responses": [
      {
        "survey_id": "string",
        "resource_id": "string",
        "resource_type": "string",
        "answers": [],
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  }
]

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	The direct session ID
host_id	Text	The host ID
start_at	Text	Start at datetime
end_at	Text	End at datetime
status	Text	The direct session status
created_at	Text	Created at datetime
updated_at	Text	Updated at datetime
hash_id	Text	Hashed of id
utm_source	Text	UTM source
is_test	Yes / No	Flag this direct session is a test
is_private	Yes / No	This direct session is booked from private host URL
is_blocked_by	Text	This direct session is blocked by the host
url_type	Text	URL source that user creates direct session from
num_by_guest	Number	Show the number of direct session via the guest email
is_recorded	Yes / No	Determine the direct session is recorder or not
guests[]	List	List of guests
guests[].family_name	Text	The family name of guest
guests[].first_name	Text	The first name of guest
guests[].family_furigana	Text	The family name of furigana format
guests[].first_furigana	Text	The first name of furigana format
guests[].family_katakana	Text	The family name of katakana format
guests[].first_katakana	Text	The first name of katakana format
guests[].email	Text	Guest email
guests[].phone_number	Text	Guest's phone number
guests[].external_id	Text	Guest external id
guests[].web_id	Text	Guest web id
guests[].hash_id	Text	Hashed of id
guests[].is_booker	Yes / No	Guest is booker
guests[].visitor_id	Text	Visitor id
guests[].identity	Number	Guest identity
guests[].attendee	Any	Attendee information
guests[].attendee.id	Text	Attendee ID
guests[].attendee.external_user_id	Text	External user ID
guests[].attendee.join_token	Text	Join token
guests[].full_name	Text	Full name of guest
guests[].id	Text	Guest id
guests[].is_survey_enabled	Yes / No	Flag to enable survey
host	Any
host.id	Text	Unique identifier for the host
host.email	Text	Email address of the host
host.full_name	Text	Full name of the host
host.display_name	Text	Display name of the host
host.role	Text	Role of the host
host.profile	Object	Host profile information
host.profile.introduction	Text	Host introduction
host.profile.position	Text	Host position
host.profile.nickname	Text	Host nickname
host.number_of_scheduled_sessions	Number	Number of scheduled sessions
host.number_of_onhold_sessions	Number	Number of sessions on hold
responses[]	List	List of responses
responses[].survey_id	Text	Survey id
responses[].resource_id	Text	Resource id
responses[].resource_type	Text	Resource type
responses[].answers[]	List	The answer list
responses[].answers[].question_id	Text	The question ID
responses[].answers[].response_id	Text	Response ID
responses[].answers[].survey_id	Text	Survey ID
responses[].answers[].answer	Object	The question's response
responses[].answers[].assets[]	List	Assets
responses[].answers[].assets[].id	Text	Asset id
responses[].answers[].assets[].name	Text	File name
responses[].answers[].assets[].mime_type	Text	MIME Type
responses[].answers[].assets[].size	Number	Size of file
responses[].answers[].assets[].path	Text	URL of file
responses[].answers[].assets[].resource_type	Text	One of resource type defined in settings SUPPORTED_ASSET_RESOURCE_TYPE
responses[].answers[].assets[].resource_id	Text	Resource Id
responses[].answers[].assets[].index	Number	Index of asset in the list
responses[].answers[].assets[].created_at	Text	Created at datetime
responses[].answers[].response_resource_id	Text	Response resource id
responses[].answers[].response_resource_type	Text	Response resource type
responses[].created_at	Text	Created at datetime
responses[].updated_at	Text	Updated at datetime

Retrieve Direct Session

Retrieve a direct session by ID

Settings

Field	Type	Required	Description
Direct Session ID	Text	Yes	ID of the direct session

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "host_id": "string",
  "start_at": "string",
  "end_at": "string",
  "status": "created",
  "created_at": "string",
  "updated_at": "string",
  "hash_id": "string",
  "utm_source": "string",
  "is_test": false,
  "is_private": false,
  "is_blocked_by": "string",
  "url_type": "string",
  "num_by_guest": 1,
  "is_recorded": false,
  "guests": [
    {
      "family_name": "string",
      "first_name": "string",
      "family_furigana": "string",
      "first_furigana": "string",
      "family_katakana": "string",
      "first_katakana": "string",
      "email": "string",
      "phone_number": "string",
      "external_id": "string",
      "web_id": "string",
      "hash_id": "string",
      "is_booker": false,
      "visitor_id": "string",
      "identity": 0,
      "attendee": {},
      "full_name": "string",
      "id": "string",
      "is_survey_enabled": true
    }
  ],
  "host": {},
  "responses": [
    {
      "survey_id": "string",
      "resource_id": "string",
      "resource_type": "string",
      "answers": [
        {}
      ],
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	The direct session ID
host_id	Text	The host ID
start_at	Text	Start at datetime
end_at	Text	End at datetime
status	Text	The direct session status
created_at	Text	Created at datetime
updated_at	Text	Updated at datetime
hash_id	Text	Hashed of id
utm_source	Text	UTM source
is_test	Yes / No	Flag this direct session is a test
is_private	Yes / No	This direct session is booked from private host URL
is_blocked_by	Text	This direct session is blocked by the host
url_type	Text	URL source that user creates direct session from
num_by_guest	Number	Show the number of direct session via the guest email
is_recorded	Yes / No	Determine the direct session is recorder or not
guests[]	List	List of guests
guests[].family_name	Text	The family name of guest
guests[].first_name	Text	The first name of guest
guests[].family_furigana	Text	The family name of furigana format
guests[].first_furigana	Text	The first name of furigana format
guests[].family_katakana	Text	The family name of katakana format
guests[].first_katakana	Text	The first name of katakana format
guests[].email	Text	Guest email
guests[].phone_number	Text	Guest's phone number
guests[].external_id	Text	Guest external id
guests[].web_id	Text	Guest web id
guests[].hash_id	Text	Hashed of id
guests[].is_booker	Yes / No	Guest is booker
guests[].visitor_id	Text	Visitor id
guests[].identity	Number	Guest identity
guests[].attendee	Any	Attendee information
guests[].attendee.id	Text	Attendee ID
guests[].attendee.external_user_id	Text	External user ID
guests[].attendee.join_token	Text	Join token
guests[].full_name	Text	Full name of guest
guests[].id	Text	Guest id
guests[].is_survey_enabled	Yes / No	Flag to enable survey
host	Any
host.id	Text	Unique identifier for the host
host.email	Text	Email address of the host
host.full_name	Text	Full name of the host
host.display_name	Text	Display name of the host
host.role	Text	Role of the host
host.profile	Object	Host profile information
host.profile.introduction	Text	Host introduction
host.profile.position	Text	Host position
host.profile.nickname	Text	Host nickname
host.number_of_scheduled_sessions	Number	Number of scheduled sessions
host.number_of_onhold_sessions	Number	Number of sessions on hold
responses[]	List	List of responses
responses[].survey_id	Text	Survey id
responses[].resource_id	Text	Resource id
responses[].resource_type	Text	Resource type
responses[].answers[]	List	The answer list
responses[].answers[].question_id	Text	The question ID
responses[].answers[].response_id	Text	Response ID
responses[].answers[].survey_id	Text	Survey ID
responses[].answers[].answer	Object	The question's response
responses[].answers[].assets[]	List	Assets
responses[].answers[].assets[].id	Text	Asset id
responses[].answers[].assets[].name	Text	File name
responses[].answers[].assets[].mime_type	Text	MIME Type
responses[].answers[].assets[].size	Number	Size of file
responses[].answers[].assets[].path	Text	URL of file
responses[].answers[].assets[].resource_type	Text	One of resource type defined in settings SUPPORTED_ASSET_RESOURCE_TYPE
responses[].answers[].assets[].resource_id	Text	Resource Id
responses[].answers[].assets[].index	Number	Index of asset in the list
responses[].answers[].assets[].created_at	Text	Created at datetime
responses[].answers[].response_resource_id	Text	Response resource id
responses[].answers[].response_resource_type	Text	Response resource type
responses[].created_at	Text	Created at datetime
responses[].updated_at	Text	Updated at datetime

Create Direct Session

Create a new direct session

Settings

Field	Type	Required	Description
Store ID	Text	Yes	ID of the store
Guest	Object		Guest information
VS Organization ID	Text	Yes	VS ID of the organization
UTM Source	Text		UTM source
Host ID	Text		Host ID
Key	Text		Private key for the personal direct session
Is Test	Yes / No		Flag for test mode Default: false
URL Type	Choice		URL source that user creates direct session from Options: Store, Host, Organization Default: store

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "host_id": "string",
  "start_at": "string",
  "end_at": "string",
  "status": "created",
  "created_at": "string",
  "updated_at": "string",
  "hash_id": "string",
  "utm_source": "string",
  "is_test": false,
  "is_private": false,
  "is_blocked_by": "string",
  "url_type": "string",
  "num_by_guest": 1,
  "is_recorded": false,
  "guests": [
    {
      "family_name": "string",
      "first_name": "string",
      "family_furigana": "string",
      "first_furigana": "string",
      "family_katakana": "string",
      "first_katakana": "string",
      "email": "string",
      "phone_number": "string",
      "external_id": "string",
      "web_id": "string",
      "hash_id": "string",
      "is_booker": false,
      "visitor_id": "string",
      "identity": 0,
      "attendee": {},
      "full_name": "string",
      "id": "string",
      "is_survey_enabled": true
    }
  ],
  "host": {},
  "responses": [
    {
      "survey_id": "string",
      "resource_id": "string",
      "resource_type": "string",
      "answers": [
        {}
      ],
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	The direct session ID
host_id	Text	The host ID
start_at	Text	Start at datetime
end_at	Text	End at datetime
status	Text	The direct session status
created_at	Text	Created at datetime
updated_at	Text	Updated at datetime
hash_id	Text	Hashed of id
utm_source	Text	UTM source
is_test	Yes / No	Flag this direct session is a test
is_private	Yes / No	This direct session is booked from private host URL
is_blocked_by	Text	This direct session is blocked by the host
url_type	Text	URL source that user creates direct session from
num_by_guest	Number	Show the number of direct session via the guest email
is_recorded	Yes / No	Determine the direct session is recorder or not
guests[]	List	List of guests
guests[].family_name	Text	The family name of guest
guests[].first_name	Text	The first name of guest
guests[].family_furigana	Text	The family name of furigana format
guests[].first_furigana	Text	The first name of furigana format
guests[].family_katakana	Text	The family name of katakana format
guests[].first_katakana	Text	The first name of katakana format
guests[].email	Text	Guest email
guests[].phone_number	Text	Guest's phone number
guests[].external_id	Text	Guest external id
guests[].web_id	Text	Guest web id
guests[].hash_id	Text	Hashed of id
guests[].is_booker	Yes / No	Guest is booker
guests[].visitor_id	Text	Visitor id
guests[].identity	Number	Guest identity
guests[].attendee	Any	Attendee information
guests[].attendee.id	Text	Attendee ID
guests[].attendee.external_user_id	Text	External user ID
guests[].attendee.join_token	Text	Join token
guests[].full_name	Text	Full name of guest
guests[].id	Text	Guest id
guests[].is_survey_enabled	Yes / No	Flag to enable survey
host	Any
host.id	Text	Unique identifier for the host
host.email	Text	Email address of the host
host.full_name	Text	Full name of the host
host.display_name	Text	Display name of the host
host.role	Text	Role of the host
host.profile	Object	Host profile information
host.profile.introduction	Text	Host introduction
host.profile.position	Text	Host position
host.profile.nickname	Text	Host nickname
host.number_of_scheduled_sessions	Number	Number of scheduled sessions
host.number_of_onhold_sessions	Number	Number of sessions on hold
responses[]	List	List of responses
responses[].survey_id	Text	Survey id
responses[].resource_id	Text	Resource id
responses[].resource_type	Text	Resource type
responses[].answers[]	List	The answer list
responses[].answers[].question_id	Text	The question ID
responses[].answers[].response_id	Text	Response ID
responses[].answers[].survey_id	Text	Survey ID
responses[].answers[].answer	Object	The question's response
responses[].answers[].assets[]	List	Assets
responses[].answers[].assets[].id	Text	Asset id
responses[].answers[].assets[].name	Text	File name
responses[].answers[].assets[].mime_type	Text	MIME Type
responses[].answers[].assets[].size	Number	Size of file
responses[].answers[].assets[].path	Text	URL of file
responses[].answers[].assets[].resource_type	Text	One of resource type defined in settings SUPPORTED_ASSET_RESOURCE_TYPE
responses[].answers[].assets[].resource_id	Text	Resource Id
responses[].answers[].assets[].index	Number	Index of asset in the list
responses[].answers[].assets[].created_at	Text	Created at datetime
responses[].answers[].response_resource_id	Text	Response resource id
responses[].answers[].response_resource_type	Text	Response resource type
responses[].created_at	Text	Created at datetime
responses[].updated_at	Text	Updated at datetime