Help Scout EN ESTA PÁGINA
Help Scout is an easy-to-use help desk software that enables small companies to provide their contacts with personalized support.
Help Scout integration replicates data using the Help Scout Mailbox API 2.0 .
See the
Schema section for a list of objects available for replication.
Captura de funciones Una visión detallada de este conector, incluye enlaces útiles y funcionalidad compatible.
Preparing for authentication To access your data, you need to authenticate the connection with your account credentials.
Nota informativa Asegúrese de que la cuenta que utiliza tenga acceso de lectura a las tablas que desea recuperar.
Creating the connection For more information, see Conexión a aplicaciones SaaS
Click Authenticate when you have filled in the required connection settings.
You may be asked to log in to the source application.
A window is displayed with an authentication code.
Copy the code to the clipboard and return to the connection dialog.
Paste the code in Complete authentication with the code provided by the source and click Verify .
Nota de sugerencia You may need to scroll down to see this field.
When status is Verified , the authentication is verified.
Provide a name for the connection in Connection name .
Select Open connection metadata to define metadata for the connection when it has been created.
Connection settings Setting Description Data gateway
Seleccione una Data Movement gateway si su caso de uso así lo requiere.
Nota informativa Este campo no está disponible con la suscripción Qlik Talend Cloud Starter porque Data Movement gateway no se admite. Si tiene otro nivel de suscripción y no desea utilizar Data Movement gateway , seleccione Ninguna .
Para obtener información sobre las ventajas de Data Movement gateway y los casos de uso que lo requieren, consulte Pasarela de movimiento de datos de Qlik
Start Date Indique la fecha, en el formato MM/DD/YYYY, a partir de la cual deben replicarse los datos de su fuente a su destino.
App ID App ID. App Secret App Secret.
Nota informativa Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.
The schema and info displayed below is for version 1.
Depending on your destination, table and column names may not appear as they are outlined below.
conversation_threads
The conversation_threads table contains info about the threads that make up conversations
conversation_threads table foreign keys Join conversation_threads with on conversations conversation_threads.conversation_id = conversations.id conversation_threads.customer.id = conversations.primary_customer.id conversation_threads.assigned_to.id = conversations.assignee.id conversation_threads.created_by.id = conversations.assignee.id conversation_threads.assigned_to.id = conversations.closed_by conversation_threads.created_by.id = conversations.closed_by conversation_threads.assigned_to.id = conversations.created_by.id conversation_threads.created_by.id = conversations.created_by.id customers conversation_threads.customer.id = customers.id users conversation_threads.assigned_to.id = users.id conversation_threads.created_by.id = users.id
conversation_threads table schema
action
OBJECT
This is a nested data structure:
assigned_to
OBJECT
This is a nested data structure:
email: STRING first: STRING id: INTEGER last: STRING photo_url: STRING type: STRING
attachments
ARRAY
This is a nested data structure.
bcc
ARRAY
This is a nested data structure.
body
STRING
cc
ARRAY
This is a nested data structure.
conversation_id
INTEGER
created_at
DATE-TIME
created_by
OBJECT
This is a nested data structure:
email: STRING first: STRING id: INTEGER last: STRING photo_url: STRING type: STRING
customer
OBJECT
This is a nested data structure:
email: STRING first: STRING id: INTEGER last: STRING photo_url: STRING
id
INTEGER
opened_at
DATE-TIME
saved_reply_id
INTEGER
source
OBJECT
This is a nested data structure:
state
STRING
status
STRING
to
ARRAY
This is a nested data structure.
type
STRING
conversations
The conversations table contains info about the conversations in your Help Scout mailbox. Stitch will replicate all conversations, including active, closed, open, pending, and spam.
Note : If custom fields are available, Stitch will replicate them.
conversations table foreign keys Join conversations with on conversation_threads conversations.id = conversation_threads.conversation_id conversations.primary_customer.id = conversation_threads.customer.id conversations.assignee.id = conversation_threads.assigned_to.id conversations.closed_by = conversation_threads.assigned_to.id conversations.created_by.id = conversation_threads.assigned_to.id conversations.assignee.id = conversation_threads.created_by.id conversations.closed_by = conversation_threads.created_by.id conversations.created_by.id = conversation_threads.created_by.id customers conversations.primary_customer.id = customers.id mailbox_folders conversations.folder_id = mailbox_folders.id conversations.mailbox_id = mailbox_folders.mailbox_id mailbox_fields conversations.mailbox_id = mailbox_fields.mailbox_id mailboxes conversations.mailbox_id = mailboxes.id workflows conversations.mailbox_id = workflows.mailbox_id users conversations.assignee.id = users.id conversations.closed_by = users.id conversations.created_by.id = users.id
conversations table schema
assignee
OBJECT
This is a nested data structure:
email: STRING first: STRING id: INTEGER last: STRING photo_url: STRING type: STRING
bcc
ARRAY
This is a nested data structure.
cc
ARRAY
This is a nested data structure.
closed_at
DATE-TIME
closed_by
INTEGER
created_at
DATE-TIME
created_by
OBJECT
This is a nested data structure:
email: STRING first: STRING id: INTEGER last: STRING photo_url: STRING type: STRING
custom_fields
ARRAY
This is a nested data structure:
id: INTEGER name: STRING text: STRING value: STRING
customer_waiting_since
OBJECT
This is a nested data structure:
friendly: STRING last_reply_from: STRING time: DATE-TIME
folder_id
INTEGER
id
INTEGER
mailbox_id
INTEGER
number
INTEGER
preview
STRING
primary_customer
OBJECT
This is a nested data structure:
email: STRING first: STRING id: INTEGER last: STRING photo_url: STRING type: STRING
source
OBJECT
This is a nested data structure:
state
STRING
status
STRING
subject
STRING
tags
ARRAY
This is a nested data structure:
color: STRING id: INTEGER tag: STRING
threads
INTEGER
type
STRING
updated_at
DATE-TIME
user_updated_at
DATE-TIME
customers
The customers table contains info about the customers in your Help Scout account.
customers table foreign keys customers table schema
address
OBJECT
This is a nested data structure:
city: STRING country: STRING lines: ARRAY, which is also a nested data structure. postal_code: STRING state: STRING
age
STRING
background
STRING
chats
ARRAY
This is a nested data structure:
id: INTEGER type: STRING value: STRING
created_at
DATE-TIME
emails
ARRAY
This is a nested data structure:
id: INTEGER type: STRING value: STRING
first_name
STRING
gender
STRING
id
INTEGER
job_title
STRING
last_name
STRING
location
STRING
organization
STRING
phones
ARRAY
This is a nested data structure:
id: INTEGER type: STRING value: STRING
photo_type
STRING
photo_url
STRING
properties
ARRAY
This is a nested data structure:
name: STRING type: STRING value: STRING
social_profiles
ARRAY
This is a nested data structure:
id: INTEGER type: STRING value: STRING
updated_at
DATE-TIME
websites
ARRAY
This is a nested data structure:
happiness_ratings_report
The happiness ratings report provides a company’s ratings for a specified time range.
Replication Method
Full Table
Primary Keys
conversation_id
rating_created_at
rating_customer_id
Useful links
Help Scout API method
happiness_ratings_report table schema
conversation_id
INTEGER
rating_comments
STRING
rating_created_at
DATE-TIME
rating_customer_id
INTEGER
rating_customer_name
STRING
rating_id
INTEGER
rating_user_id
INTEGER
rating_user_name
STRING
thread_created_at
DATE-TIME
thread_id
INTEGER
type
STRING
mailbox_fields
The mailbox_fields table contains info about the custom fields associated with your Help Scout mailboxes.
mailbox_fields table foreign keys Join mailbox_fields with on conversations mailbox_fields.mailbox_id = conversations.mailbox_id mailbox_folders mailbox_fields.mailbox_id = mailbox_folders.mailbox_id mailboxes mailbox_fields.mailbox_id = mailboxes.id workflows mailbox_fields.mailbox_id = workflows.mailbox_id
mailbox_fields table schema
id
INTEGER
mailbox_id
INTEGER
name
STRING
options
ARRAY
This is a nested data structure:
id: INTEGER label: STRING order: INTEGER
order
INTEGER
required
BOOLEAN
type
STRING
mailbox_folders
The mailbox_folders table contains info about the mailbox folders in your Help Scout account.
mailbox_folders table foreign keys Join mailbox_folders with on conversations mailbox_folders.id = conversations.folder_id mailbox_folders.mailbox_id = conversations.mailbox_id mailbox_fields mailbox_folders.mailbox_id = mailbox_fields.mailbox_id mailboxes mailbox_folders.mailbox_id = mailboxes.id workflows mailbox_folders.mailbox_id = workflows.mailbox_id
mailbox_folders table schema
active_count
INTEGER
id
INTEGER
mailbox_id
INTEGER
name
STRING
total_count
INTEGER
type
STRING
updated_at
DATE-TIME
user_id
INTEGER
mailboxes
The mailboxes table contains info about the mailboxes in your Help Scout account.
mailboxes table foreign keys mailboxes table schema
created_at
DATE-TIME
email
STRING
id
INTEGER
name
STRING
slug
STRING
updated_at
DATE-TIME
team_members
This report contains information about team members.
team_members table schema
team_id
INTEGER
user_id
INTEGER
teams
This report contains information about all the different teams in the company.
teams table schema
created_at
DATE-TIME
id
INTEGER
initials
STRING
mention
STRING
name
STRING
photo_url
STRING
timezone
STRING
updated_at
DATE-TIME
users
The users table contains info about the users in your Help Scout account.
users table foreign keys Join users with on conversation_threads users.id = conversation_threads.assigned_to.id users.id = conversation_threads.created_by.id conversations users.id = conversations.assignee.id users.id = conversations.closed_by users.id = conversations.created_by.id
users table schema
created_at
DATE-TIME
email
STRING
first_name
STRING
id
INTEGER
last_name
STRING
photo_url
STRING
role
STRING
timezone
STRING
type
STRING
updated_at
DATE-TIME
workflows
The workflows table contains info about the workflows in your Help Scout account.
workflows table foreign keys workflows table schema
created_at
DATE-TIME
id
INTEGER
mailbox_id
INTEGER
modified_at
DATE-TIME
name
STRING
order
INTEGER
status
STRING
type
STRING
