Step 1: Apply the Survey Starter

light bulb
Prerequisites
The only prerequisite required to install this starter is a Yext Pages package. No other licenses are required to install this starter! Note that the first few steps of the installation flow will require you to generate an API key in your account so that the starter can automatically send form data to your account from the Pages frontend.
  1. First, you’ll need to generate an API key on your account so that you can receive survey data when users complete your form. Log into your Yext account and navigate to Developer > Developer Console. In the top right corner, click + Add an App.
  2. Give your app a name, something like Receive Survey Information. Click Create App.
  3. Under the API Credentials tab, add an API Permission. Add an endpoint for Management API > Entities, and choose Read/Write permissions.
  4. Click Save, and then Change Permissions. Copy the new API key generated below your permissions. You’ll need it in a few steps.
  5. Now it’s time to install the starter! Navigate to Apps > Solutions from the left-side navigation bar
  6. Click on Survey Starter Template.
  7. Review the overview of the starter and resources included. Then click View Solution to see all resources in the Yext Admin Console.
  8. In the top right corner, click Apply.
  9. Input your account ID, the string of numbers included in any URL of the Yext platform, e.g., https://www.yext.com/s/1234567/apps/solutions.
  10. You will likely have to click Start Authorization Flow to allow your account to receive these resources. In the new window, click Authorize.
  11. Return to the Admin Console, and click Continue.
  12. Paste the API key you generated above, in Step 4. Click Continue.
  13. Review the resources added to your account, and click Continue.
  14. Finally, click Confirm to add the new resources to your account!