Create & Manage Dynamic Lookups

This article will show you how to create a Dynamic Lookup to query external content. There are two types of dynamic lookups, Data Lookup and Element Lookup. Data Lookups are used to dynamically populate existing form elements with data. Element Lookups are used to dynamically generate form elements. 

You can also create and store a table of contents in CivicOptimize that can be looked up against in a form. Learn more on the Lookups article. 

Create a Dynamic Lookup

1. Navigate to Developer Tools and select Dynamic Lookups
   
2. Click the + button in the bottom right of the screen
   
3. Choose either the Element Lookup or Data Lookup type
   
4. Select a Lookup Source
   
   
   • Custom URL: Provide the URL for the specific API (application program interface) endpoint that you want the form data to be pushed to
   • Hosted API: Use our API Hosting service to create your own custom hosted APIs for your Lookups to point to 
   • Built In: Use Built-in data as the source of your lookup
5. Add a Lookup Label
   
   
6. If applicable, toggle on Exclude Form Definition from Lookup to reduce the size of the lookup payload and ensure that only the form submission data is passed through to your lookup endpoint
   
7. Choose the appropriate Environment
   
8. Enter the URL or API for the Lookup
   
   
   Note: This field will differ depending on the Lookup Source you chose
9. Toggle on Run Lookup on Clear if you wish to run the lookup when the user clears the input or deselect the option(s)
   
10. Select Save
    
    
11. You can now Enable a Lookup on a Form
    

Go to Article Navigation

Delete a Dynamic Lookup

Important Note

• Lookups that are in use cannot be deleted

Instructions

1. Navigate to Developer Tools > Dynamic Lookups
   
2. Click Delete next to the Lookup you wish to remove
   
3. Click Delete on the pop-up that says "Are you sure you want to delete [Name of Lookup]?"
   

Go to Article Navigation

Supporting Articles

• Enable a Lookup on a Form