# Helpshift Integration

Audience: A Helpshift domain administrator at the customer.



Oversai reads your Helpshift issues — the conversation, its state, tags, the
assigned agent and the customer's satisfaction rating — so they can be scored,
coached on and reported against.

Who does this

Helpshift Admin

Time needed

About 5 minutes

Access granted

Read-only

Auth method

API key

--------------------------------------------------------------------------------


BEFORE YOU START

 * A Helpshift account with the Admin role — only an Admin can view or create
   API keys.

 * Your Helpshift domain: the part before .helpshift.com in the address you sign
   in at. For mycompany.helpshift.com, the domain is mycompany.

 * An Oversai account with Admin access.

--------------------------------------------------------------------------------


STEP 1 — CREATE A READ-ONLY API KEY

Helpshift Dashboard > Settings > APIs

Add a key named Oversai with the Read-only permission level, then copy its
value.




WHAT THE READ-ONLY KEY ALLOWS

A read key reaches three things, and there is nothing per-endpoint to tick:

Oversai reads

What it powers in Oversai

Issues

The interaction list, its subject, state, tags, custom fields and the
conversation. Required — without it nothing syncs.

Agents

The agent name and email on each interaction, matching interactions to Oversai
users and teams, and telling an agent's message apart from the customer's.

Apps

The App filter and the app name on each interaction. Without it the filter shows
raw app identifiers.

--------------------------------------------------------------------------------


STEP 2 — CONNECT IN OVERSAI

Oversai > Data > Integrations > New Integration

 1. Choose Connect to Helpshift.

 2. Fill in the two fields below.

 3. Save.

Field

What to enter

Domain

Your Helpshift domain — mycompany for mycompany.helpshift.com. Not the full URL.

API Key

The key from step 1.

> Note: There is no region to choose: Helpshift serves every domain from the
> same API address.

If your Helpshift runs on a dedicated or regional host, contact Oversai support
before you go further.





--------------------------------------------------------------------------------


WHAT HAPPENS AFTER YOU CONNECT

The first issues appear within about five minutes. That first sync back-fills
the last 15 days; everything older stays in Helpshift.

After that Oversai checks for changes every five minutes.

A rea





Need help? If you run into any issues with the integration, email us at
support@oversai.com [support@oversai.com]. We’ll be happy to help! 😊