Objects

List of objects returned in our webhooks

Experience

Name	Type	Description
uid	string	Id of the experience
title	number	Title of the experience
type	one of TOUR, SURVEY, BANNER, HINT, CHECKLIST, POST	Type of the experience
state	one of LIVE, PAUSED	State of the experience
isDraft	boolean	Tells if an experience is still draft mode. Once the experience is published, this property is set to false.
createdAt	Date	Creation date of the experience
publishedAt	Date	Publication date of the experience
expiresAt	Date	Date at which the experience will expires
triggerType	one of DEFAULT, EVENT, MANUAL, LEAVE_PAGE, URL, NONE	How an experience is supposed to be triggered. DEFAULT correspond on the trigger on page opening.
recurrencyType	one of SINGLE_TIME, EVERY_TIME, DAY_BASED	The recurrence of an experience
recurrencyValue	number	If recurrencyType is equal to DAY_BASED, this property is the number of days.

User

Represents a member of your workspace team

Name	Type	Description
uid	string	Id of the user
email	string	Email of the user
firstName	string	First name of the user
lastName	string	Last name of the user

Jimer

Represents a user of your app

Name	Type	Description
uid	string	Id of the jimer
identifyToken	string	Identify token of the jimer. This field is set using our identify SDK method.
username	string	Username of the jimer
email	string	Email of the jimer
lastActivityAt	Date	Last time the jimer was active
createdAt	Date	Creation date of the jimer

Step

Represent a step of an experience

Name	Type	Description
uid	string	Id of the step
name	string	Name of the step
type	one of OPINION_SCALE, MULTIPLE_CHOICE_MULTI_SELECT, MULTIPLE_CHOICE_SINGLE_SELECT, TEXT_LONG, SLIDER, NPS, TEXT_BLOCK, CONCEPT_TEST, INTERVIEW, SUCCESS, CHECKLIST	Type of the step
indexOrder	number	Index order of the step (starts at 0)

Answer

Represent an answer to a step of a survey experience

Name	Type	Description
uid	string	Id of the answer
value	string	Value of the answer. Can vary based on the type of Step been answered.

Task

Represent a task of a checklist

Name	Type	Description
uid	string	Id of the task
name	string	Name of the task

Comment

Represent a comment of changelog post

Name	Type	Description
uid	string	Id of the comment
message	string	Message of the comment