Resource search
Find workflows, templates, guides, and other resources in an environment by their name, key, or content.
As you build in your Knock account and the number of resources grows, you'll likely find yourself looking for an easy way to track down a specific email by its subject line, an SMS step in a workflow by its copy, or a partial whose key you don't remember. Resource search in the Knock dashboard looks across every resource type in the environment you're working in and matches your query against each resource's name, key, and content. You can use it to find specific resources without opening each resource type's list page.
Run a search
#Open the search page in one of these ways:
- Click the magnifying glass search icon at the top of the main sidebar, next to your account menu.
- Open the command menu with Cmd + K and choose Search resources.
- Go to dashboard.knock.app/~/search.
Type your query and press Enter to run the search. When the search field isn't focused, you can press / to return to it.
The query and the selected filter are saved in the page URL, so you can bookmark a search or share it with a teammate who has access to the same environment.
Filter by resource type
#Results default to All. Use the filters under the search field to narrow results to one resource type. You'll only see filters for the resource types that your role can read.
Navigate the results
#Each result shows its type, its title with the matching words highlighted, and the key it belongs to. Liquid variables in a title appear as the variable name, so a subject line such as Welcome, {{ recipient.name }} reads as Welcome, recipient.name.
Click a result to open it, or use the arrow keys to move from the search field through the results and press Enter. Results load 50 at a time. Use Previous and Next at the bottom of the page to move between pages.
What resource search covers
#Resource search covers the versioned content in an environment. Every resource type matches on its key and name. The table below lists the additional content that Knock indexes for each type and where a result opens.
Template results come from the channel steps of your workflows and broadcasts. The result label names the channel, such as "Email template" or "SMS template," and the key shown is the workflow or broadcast that contains the step.
Resource search does not include:
- Archived resources.
- System audiences and translations that Knock manages for you.
- Recipient data, such as users, objects, and tenants. Use the dedicated list pages in the Recipients section of the sidebar for these.
- Messages and logs. Find these under the Observability section of the sidebar.
Search reflects your latest changes
#Knock indexes the current version of each resource, including changes you've saved but not yet committed. A search can return a match that isn't live in the environment yet. Knock updates the index in the background after you save a resource, so a change can take a few moments to appear in results.
How matching works
#Resource search matches whole words with English stemming, so alert also finds alerts. The final word in your query also matches as the start of a word once it has two or more characters, so onboa will match onboarding. A one-character final word only matches that character as a whole word.
Hyphens and other punctuation split words, so the key alert-digest matches both alert and digest.
Matches on a resource's key rank above matches on its name, and matches on its name rank above matches in its content. Knock can also rerank results by meaning, but a result always contains at least one word from your query.
Environments and branches
#Each environment and branch has its own search index, and a search only returns resources from the environment or branch that you currently have selected in the dashboard. To find a resource in another environment, switch to that environment and run the search again.
Permissions
#Resource search follows your role and permissions in the current environment. Knock removes resource types you can't read from the results and from the filters, so two members can see different results for the same query.
- Every resource type requires read access to that type in order to be searchable.
- Members without read access to at least one searchable resource type can't open the search page.
Search from the Knock agent
#The Knock agent uses resource search to find resources by name or content before it reads or changes them. It searches the same environment, follows the same permissions, and returns the same resource types as the search page.
Limits
#- Each page shows up to 50 results, and results don't include a total count.
- Knock indexes up to the first 12,000 characters of each resource's content. Text after that point doesn't match.
- Resource search is only available in the Knock dashboard or via the Knock agent or MCP server. It's not available via an API endpoint.