loading

Introduction| Hitchhikers Platform

light bulb
Prerequisites
This guide assumes that you have an account to get started. Don’t have an account? You can sign up for a no-obligations Free Trial here or you can create a Playground Account from your Hitchhikers Control Center.

Overview

This guide will walk you through how to create a Pull Connector.

We will be walking you through the steps using a custom YouTube Connector as an example. The Connector we build will enable us to pull Video information and metadata from our Yext YouTube channel and create Video entities in our Knowledge Graph.

You can follow along with us using this example, or you can use this as guidelines and enter your own configuration to create your own custom Connector.

If you are going to follow along and add video entities to your account you must create and enable the video entity type. To do this, follow the steps in the Create a Custom Entity Type help article.

  • Entity Type: Video
  • Fields to add:
    • ‘Description’ (built-in field)
    • ‘Video URL’ (custom URL field type)
    • ‘Channel ID’ (custom single-line text field type)
    • ‘Published at’ (custom single-line text field type)
    • ‘Thumbnail Photo’ (custom simple photo field type)

Pull API Connector Overview

This source allows you to pull data from any API and use the Connector to convert that data into entities without having to build and host an integration outside of Yext.

You will need to specify the details of the API you would like to pull data from. The values you enter and the options you select for each setting will depend on the API you are pulling from. This includes:

  • Request URL
  • Authentication Method
  • Query Parameters
  • Headers
  • Pagination Control
  • Max Requests per Minute

Before getting started creating a Pull connector, we recommend looking at the API documentation for the relevant API, and creating a test call so you can easily pull in the relevant information.

As mentioned above, we are going to create a Connector to pull YouTube videos from the Yext YouTube channel into entities in the Knowledge Graph. Let’s get started!

Splash Loading