Reference
The information gathered on this page is essential to developing your app and using the guides found on this site.

App statuses

All apps in Yext have an App Directory status: Private, Submitted, or Published.
  • Private
    • The default status when an app is created. The app is private and cannot be viewed on the App Directory.
    • An app can be developed while in Private mode, and access tokens can be requested via OAuth without restriction.
    • Possible status changes:
      • App developer submits to App Directory → Submitted
  • Submitted
    • The app has been submitted by the app developer to the Yext App Directory.
    • Yext reviews the app and makes a decision to publish the app, contact the developer to ask questions about the app, or reject the app.
    • Possible status changes:
      • App developer retracts App Directory submission → Private
      • Yext approves app → Published
      • Yext rejects app → Private
  • Published
    • The app has been published to the App Directory, and Yext will contact the developer regarding the status change. The app will be viewable on the App Directory, where customers will be able to install it.
    • If at any time Yext determines that the app is in violation of App Directory Terms and Conditions or App Directory policies, or that it is malfunctioning and causing issues in the Yext platform or for Yext customers, Yext will revoke the app. Yext will contact the app developer to resolve any issues found.
    • Possible status changes:
      • App developer unpublishes from App Directory → Private
      • Yext revokes app → Private
back to top

App configuration

When creating an app in the Developer Console, you must provide values for the following fields:
  • App Name
    • The name of your app, as it will be shown in the App Directory.
    • An email address that customers can use to send questions, comments, and support requests.
  • Contact Email
    • Valid email address
    • A contact email for the app developer, which will be used by Yext for app-submission purposes, or if we have questions or concerns about your app.
    • This email address will not be listed publicly if your app is submitted to the App Directory.
  • Contact Phone
    • Valid phone number
    • A contact phone number for the app developer, which will be used by Yext to for app-submission purposes, or if we have questions/concerns about your app.
    • This phone number will not be listed publicly if your app is submitted to the App Directory.
  • Permissions
    • The level of permissions your app needs, which is either "Read-Only" or "Read/Write". This setting will apply to all endpoints you select for your app.
  • Endpoints
    • The list of endpoints your App needs access to.
    • You must have at least one endpoint selected.
Optional fields are listed below:
  • Custom Field Behavior
    • The Custom Field behavior that your app will adhere to. More information on this setting can be found in Managing Custom Fields.
    • Cannot be "Enabled for all fields" if submitting to App Directory.
  • OAuthRedirectDomains
    • Valid list of domains
    • A list of valid domains that Yext will redirect to after a customer completes the OAuth process. The domain in your REDIRECT_URI must exactly match a domain in this list, including any subdomains.
  • API Keys
    • A list of API keys that are used to authenticate your app during OAuth access token exchanges, as well as to access your own instance of the Knowledge Manager.
    • Consider these keys your client secrets – do not expose them outside of a secure connection with Yext during API calls.
back to top

App Directory configuration

To list your app in the Yext App Directory, you must provide values for all "App Directory" fields before starting the submission process. These fields are:
  • Logo
    • At least 250 x 250 px
    • A logo that represents your app. This image generally incorporates the logo of the platform your app integrates with.
  • Categories
    • No more than three categories
    • Up to three categories that describe the purpose of your app. The first category you choose will be your primary category, which will be shown in App Directory lists.
    • Current categories:
      • Advertising & Marketing
      • Analytics & Business Intelligence
      • Content Capture
      • Customer Relationship Management
      • Customer Engagement
      • Customer Support
      • Email
      • Facilities Management & HR
      • Healthcare
      • Point of Sale
      • Social
      • Translation Services
      • Websites
  • Short Tagline
    • Up to 100 characters
    • A short description that will appear next to your App Name in App Directory lists. This text should succinctly describe what your app does.
    • Example: "Syncs Yext location data to ExampleCo CRM"
  • Detailed Description
    • Up to 5,000 characters
    • A detailed description that appears on your App Directory details page.
    • Use this text to describe what your app does, show marketing copy, list requirements to use the app, and provide basic installation instructions.
  • Vimeo Video URL
    • Valid URL for a Vimeo video
    • A video showing your app functionality to customers. This video will be embedded on your app’s listing page.
    • The video should be informative and of high quality. It should walk customers through how to set up the app, how it works, and what value it brings to them.
  • App By
    • Up to 50 characters
    • The developer’s name, as it should be shown in the App Directory.
  • Homepage
    • Valid URL
    • Homepage of your app. This URL can link to a page specifically related to your app, or it may link to the external platform homepage.
  • Customer Support Email
    • Valid email address
    • An email address that customers can use to send questions, comments, and support requests.
  • Terms of Use
    • Valid URL
    • A link to your terms of use for the app.
  • Privacy Policy
    • Valid URL
    • A link to your privacy policy for the App.
  • App Installation URL
    • Valid URL
    • The URL that launches your app, if your app is not already linked to a customer ("installed").
    • Consider opening an optional splash page to describe the app’s functionality before launching an OAuth flow.
    • App Installation URL and App Launch URL can be the same URL, if desired.
  • App Launch URL
    • Valid URL
    • The URL that launches your app, if your app is already linked to a customer ("installed").
    • Consider placing customers directly into an OAuth flow to establish identity/authorization and launch the App Configuration.
    • App Installation URL and App Launch URL can be the same URL, if desired.
  • Testing Instructions
    • Collected during the app-submission process.
    • Instructions to the Yext App Directory Review Team on how to test the full functionality of the app. Include credentials for test accounts and step-by-step instructions on how to use the app.
    • If we cannot fully test your app using these instructions, we will contact you, which will delay your approval to the App Directory.
  • Video URL
    • Collected during the app-submission process.
    • Valid URL
    • An optional video showing the Yext App Directory Review Team the functionality of your app.
    • We strongly recommend supplying a video, as it will significantly reduce the time your app is in review.
back to top

Yext brand guidelines

If you use Yext branding in your App, please adhere to our brand guidelines, as outlined on Brandfolder, and make use of the assets provided there.

back to top

Reference app implementation

We’ve created a sample reference app, which is hosted on GitHub. This reference app is designed to help you understand how to build an app according to our best practices.

back to top