<% 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 Program 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 Knowledge Assistant Track Completed Multi-Language Experiences Track Completed Fall '22 Release Highlights Track Completed Spring '23 Release Highlights Track Completed Chat Track Completed Summer '23 Release Highlights Track Completed Fall '23 Release Highlights 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
Migrate from Custom Fields API to Configuration API
Arrow Back
Completed
Introduction
Introduction
completed
Completed 1
Step 1
Update Your App
completed
Completed 2
Step 2
Retrieve Custom Fields in an Account
completed
Completed 3
Step 3
Create a New Custom Field
completed
Completed 4
Step 4
Update an Existing Custom Field
completed
home

Introduction | Yext Hitchhikers Platform

Overview

Configuration as Code (CaC) provides an interface to configure a Yext account programmatically. The Configuration API offers a REST API for managing these configuration resources.

Prior to CaC, we needed to build out dedicated REST APIs for each task. Now, we have a built-in REST API that can manage any configuration resource.

Field Configuration is an example where we built out a dedicated API. We are focused on ensuring that fields, like any other configuration resource, have full support in CaC. Thus, there is no reason to also maintain a dedicated API, as the CaC API provides the REST interface for managing fields.

Thus, to consolidate the developer experience and ensure that there is only one mechanism to programmatically manage field configuration, we are deprecating the Custom Fields API and encouraging developers to move to the CaC API.

Using Configuration as Code

Configuration as Code is a means of storing files that are a representation of how a web application is configured. When you send requests via the Resource Configuration API, we aren’t transforming your request to match the schema we maintain, you’re editing your configuration directly.

The Configuration as Code Hitchhikers module linked above is a good resource if you want to learn how to think about and use these API beyond just custom fields.

We try to specify some of the field definitions in this guide, but the active schema can always be referenced with the static link stored in the $schema field. For example, if you wanted to add a Field Permission group to your custom field, but didn’t know what valid inputs the group field takes, you could search for ‘group’ in the linked schema, and see that field expects a string like “NONE” or “GROUP1”.

Migration Process

This migration guide is intended to be a document you can follow along with to migrate Custom Fields API Endpoints to the associated Configuration API Endpoints. This means some parameters in this guide will appear static, but are so for the purposes of this migration.

Following Along

If you’re migrating from the Custom Fields API to the Configuration API, chances are there are already some custom fields in your account. If you want to see how the configuration of your fields exist in your account currently, you can follow along by navigating to the Admin Console section under the Developer tab in your Yext account.

In this UI, hovering over a given property will expose the field’s description. This way you won’t have to look it up in the schema directly.

KM CaC Resources

We’ll be focusing specifically on listing, adding, and updating from the km/fields section, but the rest of this screen can be configured by the Configuration API as well.

Limitations

There is no supported mechanism to delete Custom Fields at this time via the Resource Configuration API Endpoints. There has been zero usage of this endpoint in the last year; we do plan to add support for deletion in the near future, but given the nonexistent usage, we do not believe this addition will be required for a successful migration. If your integration requires deletion support, please reach out to your account manager and they can connect you with the product team.

Feedback
<% elem.innerText %>