UserGuiding Event Payloads

Encontre a lista de todos os eventos que a UserGuiding emite para ferramentas integradas.

Visão Geral

Neste artigo, você pode encontrar todos os eventos que a UserGuiding emite para ferramentas integradas quando a UserGuiding é usada como fonte.

Guia

Eventos de guia emitidos pelo cliente quando os usuários interagem com os guias.

guia iniciado (userguiding)

Payload

{
guideId: string
guideName: string
pageUrl: string
}

Exemplo

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

guia concluído (userguiding)

Payload

{
guideId: string
guideName: string
pageUrl: string
}

Exemplo

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

clique no botão guia (userguiding)

Payload

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

Exemplo

{
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

Acionado quando um usuário interage com um grupo de hotspots e visualiza o conteúdo do hotspot.

hotspot interagido (userguiding)

Payload

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

Exemplo

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

clique no botão do hotspot (userguiding)

Payload

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

Exemplo

{
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

Acionado quando um usuário clica em um botão em um Banner.

clique no botão do banner (userguiding)

Payload

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

Exemplo

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

Checklist

Acionado quando um usuário inicia um item do Guia em um Checklist.

checklist concluído (userguiding)

Payload

{
checklistId: string
checklistName: string
pageUrl: string
}

Exemplo

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

gatilho de item do checklist (userguiding)

Payload

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

Exemplo

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

clique no URL do item do checklist (userguiding)

Payload

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

Exemplo

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

Resource Center

Acionado quando um usuário interage com os módulos dentro de um Resource Center.

gatilho do guia do resource center (userguiding)

Payload

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

Exemplo

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

gatilho da pesquisa do resource center (userguiding)

Payload

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

Exemplo

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

gatilho do guia do checklist do resource center (userguiding)

Payload

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

Exemplo

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

clique no URL do item do checklist do resource center (userguiding)

Payload

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

Exemplo

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

clique na url externa do resource center (userguiding)

Payload

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

Exemplo

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

clique no link do artigo do resource center (userguiding)

Payload

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

Exemplo

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

Pesquisas

Acionado quando uma pesquisa é interagida por um usuário.

pesquisa mostrada (userguiding)

Payload

{
surveyId: string
surveyName: string
pageUrl: string
}

Exemplo

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

resposta à pergunta da pesquisa (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
}

Exemplo

A resposta contém pontuação se questionType for Classificação por estrelas ou Classificação numérica (5) ou Classificação numérica (10) ou Classificação NPS.

{
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'
}

Exemplo
Exemplo de resposta contém emojiScore se questionType for Emoji Rating (3) ou Emoji Rating (5) ou 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'
}

Exemplo
A resposta contém opções se questionType for de múltipla escolha.

{
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'
}

Exemplo
A resposta contém feedback se questionType for Feedback escrito.

{
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'
}

Atualizações de Produto

Acionado quando um usuário reage ou deixa comentários em uma postagem de atualizações do produto.

comentários sobre atualizações do produto (userguiding)

Payload

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

Exemplo

Payload contém pontuação

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

Exemplo
Payload contém feedback

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

Exemplo

Payload contém pontuação e feedback

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

Base de Conhecimento

Acionado quando um usuário reage ou deixa comentários sobre um artigo da Base de Conhecimento.

base de conhecimento feedback (userguiding)

Payload

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

Exemplo

Payload contains pontuação

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

Assistente IA

Acionado quando o usuário interage com o Assistente AI

início da conversa do assistente ia (userguiding)

Payload

{
threadId: string
pageUrl: string
}

Exemplo

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

mensagem do assistente ia recebida (userguiding)

Payload

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

Exemplo

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

mensagem de fallback do assistente de ia recebida (userguiding)

Payload

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

Exemplo

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

ação de fallback do assistente de ia clicada (userguiding)

Payload

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

Exemplo

Se o tipo for javascript

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

Exemplo
Se o tipo for url, o payload contém url

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

clique no artigo do assistente de ia (userguiding)

Payload

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

Exemplo

{
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'
}

acionamento do guia do assistente de ia (userguiding)

Payload

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

Exemplo

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

Isso respondeu à sua pergunta?