Outreach

How to configure a Outreach connection

This document describes the Dataworkz connector configuration required to access Outreach.

Prerequisite

Before configuring Dataworkz for Outreach, a "Connected App" needs to be configured in Outreach. Follow the steps listed below for creating an OAuth App in Outreach for Dataworkz.

1. Use Development Portal to create a new app.

2. Follow the documents below to enable connected app and to configure Oauth2.

   • https://developers.outreach.io/guides/managing-apps/

   • https://developers.outreach.io/api/oauth/

3. Keep in mind the following points while doing the same.

   • Callback URL can be found in Dataworkz UI (Refer Connecting to Outreach section for details)

   • Permissions/scopes need to be added for Outreach API. Read or write scope should be selected for the entities that need to be accessed from Outreach via Dataworkz.

4. Make note of the Client ID & Secret. These details would be required at the time of creating the connector in Dataworkz

Creating Outreach configuration in Dataworkz

1. Navigate to the configurations section of the Dataworkz platform (Gear Icon)

2. Click on SaaS Applications

3. Select Outreach

4. Click the + icon to add a new Outreach connection

   
5. Add the Outreach instance name

6. Select the OAuth

   1. Private connection

   2. Dataworkz OAuth).

7. If selected authentication type is Private Connected App then

   1. Select "Yes" if app has already been created.

   2. Select "No". Screen with the redirect URL would pop-up. Copy the redirect URL and goto Prerequisite section.

      
8. Choose the workspace that you want to use

9. Choose the collection that you would like to use

10. Choose the scope for the Outreach connection

11. Save the configuration. This would prompt you to login to Outreach account and authorize Dataworkz to access Outreach APIs

12. Newly created connection would show up in the list of Outreach configurations.

    

Add Task Configuration

Click the newly created connector and then click + icon to add new task configuration for Outreach

1. Enter name for the dataset

2. Select the Outreach entity that you need to access

3. Select the fields of the entity that need to be read

4. Select the appropriate option for reading all the historical data or for a date range

5. Select the incremental pull criteria

   • Created At

   • Updated At

6. Enable/disable recurring job

7. Click Add to save the configuration

This would complete the Dataworkz configuration for Outreach