<% user.full_name %>
<% util.level ? util.level.title : '' %>
Explorer Pioneer Apollo Viking Voyager Pathfinder Orion
Points
<% user.points ? user.points.toLocaleString() : 0 %>
Badges
<% util.badgeCount %>
Streaks
Congratulations You've <% util.newestBadge.isCurriculum ? 'completed' : 'earned' %> the
<% util.newestBadge.title %> <% util.newestBadge.isCurriculum ? 'curriculum' : 'badge' %>!
previous
next
Share to Social Media
Linked In Facebook
Status
<% util.level ? util.level.title : '' %>
<% util.level ? util.level.points : '' %>
<% util.nextLevel ? util.nextLevel.title : '' %>
<% util.nextLevel ? util.nextLevel.points : '' %>
Level up! <% util.levelPointsRemaining %> points to go
Level up! <% util.levelPointsRemaining %> points to go
Badges
Completed Hitchhikers Track Completed Content Track Completed Pages Track Completed Page Builder Track Completed Search Backend Track Completed Search Frontend Theme Track Completed Search UI React Track Completed Solution Templates and the Admin Console Track Completed Technical Skills Track Completed Platform Basics Track Completed Listings Track Completed Reviews Track Completed Industry Overview Track Completed Analytics Track Completed Industry Overview & Product Basics Track Completed Multi-Language Experiences Track Completed Chat Track
<% util.expandBadges ? 'Less' : 'More' %>
Playground Accounts
New +
No Playground Accounts
Create Playground +
View Profile
Log Out loading
Mission Complete! 🚀
Congratulations, you’ve completed your first module!

We hope you enjoy exploring the rest of the site. Please don’t forget to leave us feedback - we are constantly looking to improve. Happy Hitchhiking!
Home
Welcome to Hitchhikers! 👋
To learn more about the platform we encourage you to get started by completing the Hitchhikers Program Track and earning your first badge!
Start Here
Close notification
Guide
Create Custom OAuth Providers
Arrow Back
Completed
Introduction
Introduction
completed
Completed 1
Step 1
Add a New Custom Provider
completed
Completed 2
Step 2
Add a Linked Account
completed
Completed 3
Step 3
Managing Existing Custom Providers and Linked Accounts
completed
home

Introduction | Yext Hitchhikers Platform

Overview

In order to use OAuth 2.0 as an authentication method to access APIs in the Connectors framework, you must link an account and authenticate with the API’s provider. Any providers you wish to authenticate with that are not supported out of the box can be added as a custom provider. This may include less-used providers, or providers that require a very custom setup, such as using a business-specific authorization URL.

Use this guide to walk through adding a new custom provider and linking your account (or as many accounts as you wish) to then create Connectors using OAuth 2.0 authentication to fetch data.

As mentioned above, if your data lives within an API that requires OAuth 2.0 authentication, you can4generate a token that we can pass to the API by linking your account to Yext. Although we host a suite of built-in providers to add Linked Accounts, Custom Providers will come in handy when your specific provider is not supported, and you’d like to make an authenticated API call in a Pull Connector.

This may be the case for providers we have not yet heard of, OR for providers that require a unique developer app for every individual’s account (so a generic “Yext” app would not work in this case). Some common providers with an OAuth flow that require this include:

  1. Shopify
  2. ServiceNow
  3. Zendesk

Because the authorization URL and token URL are account specific (i.e. www.yourInstanceURL.service-now.com/oauth_oauth.do is required, rather than using a generic www.service-now.com/oauth_oauth.do authorization URL endpoint) , you’ll need to create your own developer apps in these provider accounts. When you create the app within your provider, you’ll generate a client ID, client Secret, and specific authorization and token endpoints to be provided to Yext.

<% elem.innerText %>