UserGuiding Event Payloads

Find the list of all events UserGuiding emits to integrated tools.

Overview

In this article, you can find all events UserGuiding emits to integrated tools when UserGuiding is used as a Source.

Guide

Guide events emitted by the client when users interact with Guides.

guide started (userguiding)

Payload

{
guideId: string
guideName: string
pageUrl: string
}

Example

{
guideId: '1',
guideName: 'Guide Name',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

guide completed (userguiding)

Payload

{
guideId: string
guideName: string
pageUrl: string
}

Example

{
guideId: '1',
guideName: 'Guide Name',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

guide button click (userguiding)

Payload

{
guideId: string
guideName: string
pageUrl: string
step: string
buttonId: string
type: string
action: string
ctaText: string
}

Example

{
guideId: '1',
guideName: 'Guide Name',
step: '1',
buttonId: 'f386cafa-d5ea-45e4-8a0b-969753230462',
type: 'custom',
action: 'link' | 'guide' | 'next' | 'prev' | 'step' | 'finish' | 'dismiss-hotspot' | 'close-hotspot' | 'js' | 'dismiss-guide' | 'copy' | 'survey',
ctaText: 'Button Text',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Hotspot

Triggered when a user interacts with a hotspot group and views hotspot content.

hotspot interacted (userguiding)

Payload

{
hotspotGroupId: string
hotspotGroupName: string
hotspotId: string
hotspotTitle: string
pageUrl: string
}

Example

{
hotspotGroupId: '1',
hotspotGroupName: 'Hotspot Group Name',
hotspotId: 'af3a29c1-dbb6-4d7c-b816-45f846eaf5a0',
hotspotTitle: 'Hotspot Title',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

hotspot button click (userguiding)

Payload

{
hotspotGroupId: string
hotspotGroupName: string
hotspotId: string
hotspotTitle: string
buttonId: string
type: string
action: string
ctaText: string
pageUrl: string
}

Example

{
hotspotGroupId: '1',
hotspotGroupName: 'Hotspot Group Name',
hotspotId: 'af3a29c1-dbb6-4d7c-b816-45f846eaf5a0',
hotspotTitle: 'Hotspot Title',
buttonId: '4108c8af-784f-4632-ad2f-c89c17af4979',
type: 'custom',
action: 'link' | 'guide' | 'next' | 'prev' | 'step' | 'finish' | 'dismiss-hotspot' | 'close-hotspot' | 'js' | 'dismiss-guide' | 'copy' | 'survey',
ctaText: 'Button Text',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Banner

Triggered when a user clicks a button on a Banner.

banner button click (userguiding)

Payload

{
bannerId: string
bannerName: string
buttonId: string
ctaText: string
pageUrl: string
}

Example

{
bannerId: '1',
bannerName: 'Banner Name',
buttonId: '0e25a1e7-8a0c-4b9d-9559-51c9e3b500aa',
ctaText: 'Button Text',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Checklist

Triggered when a user starts a Guide item from a Checklist.

checklist completed (userguiding)

Payload

{
checklistId: string
checklistName: string
pageUrl: string
}

Example

{
checklistId: '1',
checklistName: 'Checklist Name',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

checklist item trigger (userguiding)

Payload

{
checklistId: string
checklistName: string
guideId: string
guideName: string
pageUrl: string
}

Example

{
checklistId: '1',
checklistName: 'Checklist Name',
guideId: '1',
guideName: 'Guide Name',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

checklist item url click (userguiding)

Payload

{
checklistId: string
checklistName: string
checklistItemUrl: string
pageUrl: string
}

Example

{
checklistId: '1',
checklistName: 'Checklist Name',
checklistItemUrl: 'https://help.userguiding.com/en',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Resource Center

Triggered when a user interacts with the modules inside a Resource Center.

resource center guide trigger (userguiding)

Payload

{
resourceCenterId: string
resourceCenterName: string
guideId: string
guideName: string
pageUrl: string
}

Example

{
resourceCenterId: '1',
resourceCenterName: 'Resource Center Name',
guideId: '1',
guideName: 'Guide Name',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

resource center survey trigger (userguiding)

Payload

{
resourceCenterId: string
resourceCenterName: string
surveyId: string
surveyName: string
pageUrl: string
}

Example

{
resourceCenterId: '1',
resourceCenterName: 'Resource Center Name',
surveyId: '1',
surveyName: 'Survey Name',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

resource center checklist guide trigger (userguiding)

Payload

{
resourceCenterId: string
resourceCenterName: string
checklistId: string
checklistName: string
guideId: string
guideName: string
pageUrl: string
}

Example

{
resourceCenterId: '1',
resourceCenterName: 'Resource Center Name',
checklistId: '1',
checklistName: 'Checklist Name',
guideId: '1',
guideName: 'Guide Name',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

resource center checklist item url click (userguiding)

Payload

{
resourceCenterId: string
resourceCenterName: string
checklistId: string
checklistName: string
checklistItemUrl: string
pageUrl: string
}

Example

{
resourceCenterId: '1',
resourceCenterName: 'Resource Center Name',
checklistId: '1',
checklistName: 'Checklist Name',
checklistItemUrl: 'https://help.userguiding.com',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

resource center external url click (userguiding)

Payload

{
resourceCenterId: string
resourceCenterName: string
externalUrl: string
pageUrl: string
}

Example

{
resourceCenterId: '1',
resourceCenterName: 'Resource Center Name',
externalUrl: 'https://updates.userguiding.com',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

resource center article link click (userguiding)

Payload

{
resourceCenterId: string
resourceCenterName: string
articleLink: string
pageUrl: string
}

Example

{
resourceCenterId: '1',
resourceCenterName: 'Resource Center Name',
articleLink: 'https://help.userguiding.com/en/articles/3420081-userguiding-javascript-api',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Survey

Triggered when a survey is interacted by a user.

survey shown (userguiding)

Payload

{
surveyId: string
surveyName: string
pageUrl: string
}

Example

{
surveyId: '1',
surveyName: 'Survey Name',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

survey question answer (userguiding)

Payload

{
surveyId: string
surveyName: string
questionId: string
questionType: string
surveyQuestion: string
score?: number
emojiScore?: 'Positive' | 'Slightly Positive' | 'Neutral' | 'Slightly Negative' | 'Negative'
choices?: string
feedback?: string
pageUrl: string
}

Example

Answer contains score if questionType is Star Rating or Number Rating (5) or Number Rating (10) or NPS Rating

{
surveyId: '1',
surveyName: 'Survey Name',
questionId: '9571b38d-0f26-4883-9e2d-e55e6567e6a1',
questionType: 'Star Rating' | 'Number Rating (5)' | 'Number Rating (10)' | 'NPS Rating',
surveyQuestion: 'How likely are you to recommend our product to your friends or colleagues?',
score: 10,
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Example
Answer contains emojiScore if questionType is Emoji Rating (3) or Emoji Rating (5) or Thumbs Up/Down

{
surveyId: '1',
surveyName: 'Survey Name',
questionId: '9571b38d-0f26-4883-9e2d-e55e6567e6a1',
questionType: 'Emoji Rating' | 'Thumbs Up/Down',
surveyQuestion: 'Did you like our new feature?',
emojiScore: 'Positive',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Example
Answer contains choices if questionType is Multiple Choice

{
surveyId: '1',
surveyName: 'Survey Name',
questionId: '9571b38d-0f26-4883-9e2d-e55e6567e6a1',
questionType: 'Multiple Choice',
surveyQuestion: 'Select the category of your issue?',
choices: 'Option1,Option2',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Example
Answer contains feedback if questionType is Written Feedback

{
surveyId: '1',
surveyName: 'Survey Name',
questionId: '9571b38d-0f26-4883-9e2d-e55e6567e6a1',
questionType: 'Written Feedback',
surveyQuestion: 'What other features would you like our solution to offer?',
feedback: 'User feedback',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Product Updates

Triggered when a user reacts or leaves feedback on a Product Updates post.

product updates feedback (userguiding)

Payload

{
postId: string
postName: string
emojiScore?: 'Positive' | 'Neutral' | 'Negative'
feedback?: string
pageUrl: string
}

Example

Payload contains score

{
postId: '1',
postName: 'Post Name',
emojiScore: 'Positive' | 'Neutral' | 'Negative',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Example
Payload contains feedback

{
postId: '1',
postName: 'Post Name',
feedback: 'User feedback',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Example

Payload contains score and feedback

{
postId: '1',
postName: 'Post Name',
emojiScore: 'Positive' | 'Neutral' | 'Negative',
feedback: 'User feedback',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Knowledge Base

Triggered when a user reacts or leaves feedback on a Knowledge Base article.

knowledge base feedback (userguiding)

Payload

{
articleId: string
articleName: string
emojiScore: 'Positive' | 'Neutral' | 'Negative'
pageUrl: string
}

Example

Payload contains score

{
articleId: '1',
articleName: 'Article Name',
emojiScore: 'Positive',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

AI Assistant

Triggered when the user interacts with the AI Assistant

ai assistant conversation start (userguiding)

Payload

{
threadId: string
pageUrl: string
}

Example

{
threadId: 'c2f1c1e3-8c11-4e09-9ff8-6b15bd89931c',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

ai assistant message receive (userguiding)

Payload

{
threadId: string
role: 'assistant'
message: string
pageUrl: string
}

Example

{
threadId: 'c2f1c1e3-8c11-4e09-9ff8-6b15bd89931c',
role: 'assistant',
message: 'Message from AI Assistant',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

ai assistant fallback message receive (userguiding)

Payload

{
threadId: string
role: 'assistant'
message: string
pageUrl: string
}

Example

{
threadId: 'c2f1c1e3-8c11-4e09-9ff8-6b15bd89931c',
role: 'assistant',
message: 'Fallback Message from AI Assistant',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

ai assistant fallback action click (userguiding)

Payload

{
threadId: string
type: 'javascript' | 'url'
url?: string
pageUrl: string
}

Example

If type is javascript

{
threadId: 'c2f1c1e3-8c11-4e09-9ff8-6b15bd89931c',
type: 'javascript',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Example
If type is url, payload contains url

{
threadId: 'c2f1c1e3-8c11-4e09-9ff8-6b15bd89931c',
type: 'url',
url: 'https://help.userguiding.com',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

ai assistant article click (userguiding)

Payload

{
threadId: string
articleId: string
articleName: string
articleLink: string
pageUrl: string
}

Example

{
threadId: 'c2f1c1e3-8c11-4e09-9ff8-6b15bd89931c',
articleId: '3420081',
articleName: 'UserGuiding JavaScript API',
articleLink: 'https://help.userguiding.com/en/articles/3420081-userguiding-javascript-api',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

ai assistant guide trigger (userguiding)

Payload

{
threadId: string
guideId: string
guideName: string
pageUrl: string
}

Example

{
threadId: 'c2f1c1e3-8c11-4e09-9ff8-6b15bd89931c',
guideId: '1',
guideName: 'Guide Name',
pageUrl: 'https://panel.userguiding.com/dashboard'
}

Did this answer your question?