Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from an Outreach source in Nexla.
outreach_api.png

Outreach

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Outreach connector tile from the list of available connectors. Then, select the credential that will be used to connect to your Outreach account, and click Next; or, create a new Outreach credential for use in this flow.

  3. In Nexla, Outreach data sources can be created using pre-built endpoint templates, which expedite source setup for common Outreach endpoints. Each template is designed specifically for the corresponding Outreach endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Outreach sources can also be configured manually, allowing you to ingest data from Outreach endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Outreach endpoints. Each template is designed specifically for the corresponding Outreach endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Fetch all Records of a Resource

    This endpoint template fetches all records of any Outreach resource type. Use this template when you need to retrieve multiple records from a specific resource type, such as accounts, opportunities, prospects, tasks, or other Outreach resources. Use the advanced tab for fetching a filtered list of records.

    • Enter the resource type in the Resource Type field. This should be the type of Outreach resource whose records you wish to fetch (e.g., accounts, opportunities, prospects, tasks, users). The resource type determines which Outreach resource will be queried. Refer to the Outreach API documentation for available resource types.

    This endpoint fetches all records of a specific Outreach resource type. The endpoint uses next URL-based pagination to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by following the links.next URL returned in the API response. The endpoint returns up to 100 records per page by default.

    You can use the advanced tab to fetch a filtered list of records by adding query parameters or filters. For detailed information about resource types, API response structures, pagination, and available resource data, see the Outreach API documentation.

    Fetch One Record of a Resource

    This endpoint template fetches a specific record of any Outreach resource type by its ID. Use this template when you need to retrieve a single record from a specific resource type, such as a specific account, opportunity, prospect, task, or other Outreach resource. Use the advanced tab for fetching a filtered list of records.

    • Enter the resource type in the Resource Type field. This should be the type of Outreach resource whose record you wish to fetch (e.g., accounts, opportunities, prospects, tasks, users). The resource type determines which Outreach resource will be queried.
    • Enter the resource ID in the Resource ID field. This should be the unique identifier of the specific record you want to retrieve. The resource ID is used to fetch a single record from the specified resource type.

    This endpoint fetches a specific record by its ID from a specific Outreach resource type. The endpoint returns a single record matching the specified resource type and resource ID. You can use the advanced tab to fetch additional related data or apply filters.

    For detailed information about resource types, resource IDs, API response structures, and available resource data, see the Outreach API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Outreach data sources can be manually configured to ingest data from any valid Outreach API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Outreach sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Outreach API from the Method pulldown menu. Outreach API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Outreach API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your Outreach endpoint (e.g., https://api.outreach.io/api/v2/accounts, https://api.outreach.io/api/v2/opportunities). Include any required query parameters in the URL (e.g., ?page[size]=100&count=false).

Ensure the API endpoint URL is correct and accessible with your current credentials. The Outreach API uses next URL-based pagination with links.next for most endpoints. The endpoint URL should include the API version (/api/v2/) and the resource type path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Outreach API responses, use $.data[*] to extract all records from the data array, or $ to extract the entire response for single record endpoints, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Outreach API response. Outreach API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. Outreach API uses next URL-based pagination with links.next for most endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For next URL-based pagination, specify the JSONPath expression to the next URL in the response ($.links["next"]).

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.