DOCS / SETUP

Setup guide

Everything in the project settings panel, in the order you will fill it in. Fifteen minutes end to end, less if you can paste your route config straight out of your Nuxt app.

What you need first

  • Prismic repository name - the subdomain of your repo, from your Prismic dashboard.
  • Vercel project ID - in Vercel under Settings → General → Project ID.
  • Vercel API token - create one under Account Settings → Tokens. It needs read access to deployments.
  • Vercel team ID - only for team or Pro accounts, under Team Settings → General → Team ID.

1. Create the project

From the projects page of an organisation, click Create Project and give it a name. The name gets slugified into the URL, so it is usually easiest to match your Prismic repository or Vercel project name. Creating projects is limited to organisation owners and admins.

Open the new project and you will see a banner saying it is not configured yet, and the settings panel open already. On a configured project you can reopen the panel any time with SETTINGS in the top right.

2. Project settings

FieldNotes
Prismic Repository NameRepository name only, not a full URL. Used for all Prismic queries and for the links that open a document in the Prismic page builder.
Vercel Project IDMasked once saved. Click into the field to see or replace the full value.
Vercel Team IDOptional. Required only if the Vercel project belongs to a team rather than a personal account.
Vercel TokenWrite only. The saved token is encrypted and never sent back to the browser, so the field always starts blank. Leave it blank to keep the existing token, or type a new one to replace it.

Click Save Settings. Saving goes through the server so the token is encrypted before storage and your organisation role is checked.

3. Routes

A route maps one Prismic document type to the URL pattern your site publishes it at. Add one per type you want audited: a document type (the Prismic custom type API ID, for example page) and a URL pattern (for example /:uid).

Two placeholders are built in:

  • :uid becomes the document UID.
  • :lang becomes the short form of the language code, so en-gb renders as en.

Any other placeholder needs a resolver, described below. Documents whose pattern cannot be fully resolved are skipped rather than reported as missing, so a route with a broken resolver goes quiet rather than noisy - worth checking if a type never appears in results.

Resolvers

A resolver maps a placeholder name to a field path on the document. Click Resolvers on a route to open the mapping editor, then add pairs like:

:continent   →   data.continent
:club        →   data.club_relation.uid

Field paths use dot and bracket notation and are read off the fetched document, so linked fields resolve through to the related document, and array fields work too, for example data.slug[0].text. A route like /destinations/:continent/:uid with a continent resolver produces /destinations/europe/paris.

Bulk import

If you already have this list in your app config, click Bulk import and paste the array straight in. JSON and plain JS object notation both parse, so unquoted keys and single quotes are fine:

[
  { type: 'page', path: '/:uid' },
  { type: 'country', resolvers: { continent: 'continent' }, path: '/destinations/:continent/:uid' }
]

Each entry needs type and path; resolvers is optional and any other key, such as a uid from your own config, is ignored. The import validates before it writes: every placeholder other than :uid and :lang must have a matching resolver, and if any row fails nothing is imported. Tick Replace all existing routes to swap the whole set rather than append.

4. Languages

Optional. Add the Prismic language codes you publish in, one per row, for example en-gb. Every route is then queried once per language. If you add none, Prismic's default language is used, which is the right setting for a single-language site.

5. Automated checks

A scheduled url_audit, on the Pro plan. Free organisations show the panel greyed out with a link to upgrade.

  • Check interval - disabled, or every 1, 3, 7 or 14 days.
  • Slack webhook URL - optional. Posts to Slack when a run finds missing URLs.

Runs fire at 9:00 AM UTC on the day they are due, and the panel shows the last and next run once a schedule is saved. Each run costs the same Prismic and Vercel API calls as pressing Check URLs by hand, so prefer the longest interval that still catches problems in time. Click Save Schedule to apply - it is a separate button from Save Settings.

6. Organisation settings

Separate from project settings, reached from the org switcher in the header or at /dashboard/<org>/settings. It holds:

  • Organisation name - owners only.
  • Billing - Free or Pro, owners only. Upgrading opens Stripe checkout; on Pro, Manage billing handles cards, invoices and cancelling.
  • Members - the people in the organisation and their roles.
  • Invites - owners and admins can invite by email and share the invite link.
  • Danger zone - deleting an organisation removes every project, route and result under it, and cannot be undone.

Free organisations have one project and one user, and the URL audit only. Every other tab shows what it does and an upgrade prompt. If a Pro subscription ends, the organisation drops back to Free: nothing is deleted, but Pro tools, schedules and incoming webhooks stop until it upgrades again.

Deleting a project

Delete Project in the project settings panel removes the project along with its routes, languages and tracked URLs, and drops the billed project count. It asks for confirmation and cannot be undone.

Next

With credentials and at least one route saved, go to the url_audit tab and run your first check.