Skip to content

Advanced Embed Options

Beyond the basic embed options, FieldFlow supports advanced configuration for custom integrations.

By default, clicking a card opens the detail view within the embed. If you want detail pages to open on your own site instead, use detailUrlTemplate:

window.FieldFlow.q.push({
projectId: "...",
apiKey: "...",
container: "#fieldflow-directory",
apiBaseUrl: "https://app.getfieldflow.io",
detailUrlTemplate: "https://mysite.com/resources/{{externalId}}"
});

{{externalId}} is replaced with the record’s ID. This is useful when you have dedicated pages for each resource on your own site.

Use openRecordId to load the embed with a specific record’s detail view already open:

window.FieldFlow.q.push({
projectId: "...",
apiKey: "...",
container: "#fieldflow-directory",
apiBaseUrl: "https://app.getfieldflow.io",
openRecordId: "record-uuid-here"
});

This is useful for deep linking — for example, when a WordPress page should show a specific resource.

You can pre-select taxonomy filters so the directory loads with specific categories already active. Configure this in the Publish tab under Start with filters, or pass filter parameters in the embed config.

ModeValueDescription
Directory only"directory"Standard directory with search and filters (default)
Quiz only"quiz"Shows quiz, then filtered results
Quiz + Directory"quiz+directory"Quiz first, then full directory with results highlighted
window.FieldFlow.q.push({
// ...
mode: "quiz+directory"
});
OptionTypeDefaultDescription
projectIdstringrequiredYour project UUID
apiKeystringrequiredAPI key from Publish tab
containerstringrequiredCSS selector for mount element
apiBaseUrlstringrequiredhttps://app.getfieldflow.io
modestring"directory""directory", "quiz", or "quiz+directory"
detailUrlTemplatestringCustom URL for detail pages
openRecordIdstringOpen specific record on load
options.showSearchbooleantrueShow search box
options.showFiltersbooleantrueShow filter sidebar
options.itemsPerPagenumber20Records per page