Hey everyone!
Just a heads up that Help Scout is sunsetting its legacy API (Mailbox API 1.0) on July 8th, 2019. In order to support your existing data sources, we will be upgrading our Help Scout connector to support Mailbox API 2.0 on June 4th, 2019. For more detailed information, please visit Help Scout deprecation notices.
What’s changing and what do I need to do?
There are some things that we are unable to update for you and need action on your part after we upgrade the Help Scout connector on June 4th, 2019. The actions you must take are listed below.
Your existing Help Scout data sources were set up using Basic authentication, with your API key as the username field. With Mailbox API 2.0 version, authentication will be done via an OAuth token. To ensure that your existing Help Scout data sources continue to refresh without interruption, you need to reconfigure them with an OAuth token.
Please follow the instructions given below to update your existing data sources.
Scenario # 1
You’ve created datasources using our Help Scout Connector (and you have not customized the query).
- In your Klipfolio library, select the Help Scout data source you want to update. On the About this Datasource page, select Reconfigure Connection.
- You will now be directed to the new authentication page (see image below).
- Select Connect an Account and you’ll be prompted to input your Help Scout credentials in a pop-up browser window. Upon authorization in the pop-up browser window, a Help Scout OAuth token will be created in your Klipfolio account.
- Select Next Step to proceed to the Edit Data Source page.
- If your data source was created using a Help Scout data source template, you’ll see a screen resembling the following. Note that the Query URL will initially contain a Mailbox API 1.0 query and you’ll see the Switch to Basic settings (Recommended) button on the lower left-hand side of the page.
- Select Switch to Basic settings (Recommend) button and you’ll be directed to the following screen. Please note that you must perform this step to migrate your data source to the Mailbox API 2.0 version.
- Select Submit, double-check that your data is returned correctly and proceed to save your updated datasource.
- Repeat the reconfiguration process for all your Help Scout datasources.
- You can select the existing Help Scout OAuth token to reconfigure the remainder of your datasources (you’ll see the following screen for steps 2 and 3).
Scenario # 2
You’ve created Help Scout data sources using our Help Scout Connector with customized queries and you’ve used them in modelled data sources or Klip formulas.
In such cases, you need to manually migrate your Mailbox API 1.0 query syntax to Mailbox API 2.0 query syntax.
- Reconfigure and create an OAuth token for your existing Help Scout data sources using steps 1 through 4 from Scenario # 1 above.
- If your data source was created using a customized query, you’ll see a screen resembling the following. Note that the Query URL will contain your initial Mailbox API 1.0 query.
- Change the existing Query URL from Mailbox API 1.0 to Mailbox API 2.0 syntax. For further information regarding migrating to Mailbox API 2.0 syntax, please refer to Help Scout documentation.
- For example, Customers endpoint in Mailbox API 1.0 was https://api.helpscout.net/v1/customers.json while Mailbox API 2.0 syntax corresponds to https://api.helpscout.net/v2/customers.
- Select Submit, double-check that your data is returned correctly and proceed to save your updated datasource.
- Repeat the reconfiguration process for all your Help Scout datasources.
- You can select the existing Help Scout OAuth token to reconfigure the remainder of your datasources (example shown below).
Scenario # 3
You’ve created Help Scout data sources using our REST/URL Connector with customized queries and you’ve used them in modelled data sources or Klip formulas.
- In your Klipfolio library, select the Help Scout data source you want to update. On the About this Datasource page, select Reconfigure Connection.
- You will be directed to the Edit Data Source page, which will resemble the following. Note that the Query URL will contain your initial Mailbox API 1.0 query.
- Change the existing Query URL from Mailbox API 1.0 to Mailbox API 2.0 syntax. For further information regarding migrating to Mailbox API 2.0 syntax, please refer to Help Scout documentation.
- Expand the Authentication (OAuth, 2-Step, X-WSSE, or Basic) section and select OAuth option from the drop-down list under the Type section (see image below).
- If you have already created a valid Help Scout OAuth token in your Klipfolio account, select it from the drop-down list under the Use Existing section and skip to step #9.
- If you do not have a previously created Help Scout OAuth token, select the Create button. This will direct you to a list of services that supports OAuth tokens. Select Help Scout from this services list (see image below).
* You will see Help Scout at the bottom of the services list. - You will then be prompted to enter your Help Scout credentials and upon authorization a Help Scout token will be created for your Klipfolio account. You will see the option to edit the name of your OAuth token, edit the description and share the token with others (see image below), if you wish to do so. Select Save to proceed with the remainder of the data source reconfiguration.
- Select Next Step and you will be redirected to the Edit Data Source page, which now contains your OAuth token information.
- Select Submit, double-check that your data is returned correctly and proceed to save your updated datasource.
Note
Finally, please double-check that any modelled data sources, Klips and PowerMetrics using your Help Scout data sources are working as expected.
Let us know if you have any questions. We are here to help!