Data Fetcher Help Center
🚀 Try for free📮 Support
  • 👋Welcome
  • Create Requests
    • Create a request
    • Use table values in requests
    • Use variables in requests
    • Response field mapping
    • Schedule a request
    • Add a request trigger
    • Troubleshoot errors
    • Run request using webhook URL
    • Pre-built integrations
  • Custom Requests
    • Create a custom request
    • Set request method
    • Set request parameters
    • Request authorization
    • Set request headers
    • Add request body
    • Connect to a preset OAuth API
    • Create a custom OAuth connection
  • Advanced settings
    • Write modes
    • Update based on field(s)
    • Pagination
    • Response data transformations
    • Response JMESPath
    • Add fixed value to output
    • No output mode
    • Rate limit
    • Max response records
    • Run request from button field
    • Denormalize response
    • XML array handling
    • Fixed IP Address
  • Organise Requests
    • Run history
    • Duplicate a request
    • Delete a request
    • Add request description
    • Import request from cURL command
    • Export requests as JSON file
    • Import requests from JSON file
  • Create Sequences
    • Create a sequence
    • Schedule a sequence
    • Run sequence from button field
    • Run sequence using webhook URL
  • Account
    • Upgrade workspace
    • Authorize Data Fetcher and Airtable
    • Add user to workspace
    • Roles and permissions
    • View monthly usage
    • Update personal details
    • Update payment card
    • Update billing information
    • View invoices
    • Switch workspace
  • Get a Google Maps API Key
Powered by GitBook
On this page
  • When do I need to create a custom OAuth connection?
  • 1. Set up an app with the service that provides the API
  • 2. Create a Custom OAuth Connection in Data Fetcher
  • Custom OAuth Connection Example
  1. Custom Requests

Create a custom OAuth connection

Last updated 6 months ago

When do I need to create a custom OAuth connection?

  • The API you want to connect to only provides access via OAuth, not API keys or any other authorization method.

  • Data Fetcher does not have a for the API.

1. Set up an app with the service that provides the API

Most APIs will require you to set up an app in a developer section of your account. Check the OAuth / Authorization section of the API documentation to find out the exact steps to take. It will generally involve clicking a few buttons and adding an app, although sometimes the process is longer and requires the service to review your app.

When configuring the app, you will usually be asked for a redirect URL. This is the Data Fetcher redirect URL that you should use:

https://oauth.datafetcher.com/auth/callback

After you've set up the app, you will be provided with a client ID and client secret. Make a note of these somewhere safe.

2. Create a Custom OAuth Connection in Data Fetcher

  • in Data Fetcher.

  • Click on the Authorization tab.

  • For the Type, select OAuth.

  • Click the + New button.

  • At the bottom of the modal that opens, click create custom OAuth connection. This will open the custom OAuth connection screen, where you can enter the details of the API:

    • Name: a name that will remind you what this OAuth connection is.

    • Auth type: the OAuth type. Most OAuth APIs use OAuth 2, but some still use OAuth 1. Check the API documentation to confirm.

    • Authorization URL: the URL used for the authorization request, when Data Fetcher opens a new tab and ask for permission to access the API. This is typically something like https://example.com/oauth/v2/auth.

    • Authorization Parameters: the parameters that will be added to the Authorization URL when making the authorization request. The API documentation will have a list of these parameters. Data Fetcher will automatically include the standard OAuth parameters (response_type,client_id,redirect_uri,response_type,state,client_secret).

    • Token URL: the URL used after the authorization request to generate access tokens from the authorization code. This is typically something like https://example.com/oauth/v2/token.

    • Token Parameters. The parameters that will be added to the Token URL when making the token request. Data Fetcher will automatically add the grant_type=authorization_code parameter.

    • Client ID: the app client ID from step 1.

    • Client secret: the app client secret from step 1.

    • Scopes (comma separated): a comma separated list of the scopes that you want to access for this API. You can find these in the API documentation.

    • Request Headers: any extra headers to be supplied with every request when using this custom OAuth connection.

    • Base URL: the root URL that all requests to this API use. e.g. https://example.com/api/ .

  • After you've entered all these details, click Create connection. Data Fetcher will begin the authorization request in a new tab. If you entered all the details correctly, you'll be able to authorize Data Fetcher to access the API and use this custom OAuth connection in any custom Data Fetcher request.

Custom OAuth Connection Example

Auth type

OAuth 2

Authorization URL

https://accounts.zoho.com/oauth/v2/auth

Authorization Parameters

prompt=consent

access_type=offline

Token URL

https://accounts.zoho.com/oauth/v2/token

Client ID

Client ID from step 1.

Client secret

Client secret from step 1.

Scopes

ZOHOPEOPLE.forms.ALL

Request headers

Authorization=Bearer ${auth.accessToken}

Base URL

https://people.zoho.com/people/api/

Let's connect to the as an example.

First, we go to the and register a new client. We are given a client ID and client secret.

Now we need to add the client ID, client secret and other details in Data Fetcher by following the steps above. The provides all the values we need.

preset OAuth connection
Create a custom request
Zoho People APIs
Zoho API Console
Zoho Peoples API OAuth documentation