<% 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
Get Started with Yext Functions
Arrow Back
Completed
Introduction
Introduction
completed
Completed 1
Step 1
Creating a Plugin
completed
Completed 2
Step 2
Applying the Resources in Configuration as Code
completed
Completed 3
Step 3
Plugin Resource With a Global Defined
completed
Completed 4
Step 4
Applications of Functions
completed
home

Step 1: Creating a Plugin

Plugin Configuration as Code Resource

A Plugin is a resource that contains at least one Function. Plugins are configured using Configuration as Code. In order to create a new Plugin, you’ll need to add a new Plugin Configuration as Code resource. The schema reference of the resource can be found here .

A Plugin is a multi-file resource, so there are at least 2 resource files that need to be defined. The first is a _resource.json file that consists of the following properties:

Property Description
$id* The Configuration as Code ID of the Plugin.
$schema* The JSON schema of the resource configuration (accessed via URL).
globals The values to set on the global object for plugin invocations. For example, an API key.
memoryLimitMB The memory limit for the Plugin, in megabytes.
concurrency A hint to suggest the number of worker instances to create, between 1 and 50.

*indicates a required field.

In addition to the _resource.json file, a mod.ts file should be defined in the same directory. The mod.ts is where your Functions are defined in Typescript. Each mod.ts file can contain many Functions.

Feedback
<% elem.innerText %>