Creating A Custom Tool To Save Users Address

​

Background and Purpose

Note: Since the update of Version 2.1, a custom tool like this should not be needed since there is a pre-built tool with the same functionality. However, we felt it would still be helpful to have this documentation so that users can learn how to build the tool themselves.

​

Resources Required

• AI Assistant Dashboard - Access to custom tool creation and assistant configurations
• CRM System (e.g., GoHighLevel) - Access to automation workflows and the contact profile fields
• Endpoint URL - Generated from an inbound webhook within the CRM

​

Definition of Done

• ✅ Custom Tool: A “Save Address” custom tool is created and linked to the assistant
• ✅ Workflow Automation: A workflow is created to map the address fields in the CRM
• ✅ Testing: The AI assistant successfully collects and saves the address to the appropriate fields in the contact profile

​

Step-by-Step Process

​

1. Create the Custom Tool in AI Assistant Dashboard

​

Open AI Assistant Dashboard

1. Go to Assistants in the AI dashboard and select the assistant you want to configure
2. Under Custom Tools, click Create a Custom Tool

​

Define the Custom Tool

• Unique Name: Enter a descriptive name like “Save Address”
• Description: Add a detailed description (e.g., “Use this tool to collect and save the user’s complete address including street, city, state, and zip code.”)
• Parameters: Add these fields:
  • street
  • city
  • state
  • zip_code
• Example Data: For parameters, use an example address like “54 State Street, Albany, New York, 12207” for clarity

​

2. Generate Endpoint URL Using Inbound Webhook

​

Open a second tab for CRM Automations and follow these steps:

1. Go to Automations and create a new workflow titled Save Address Webhook

​

Add Trigger

1. Set Inbound Webhook as the trigger
2. Copy the Webhook URL generated by the inbound webhook

​

Link Webhook to Custom Tool

1. Return to the AI assistant’s Custom Tool setup
2. Paste the Webhook URL in the endpoint field
3. Test by clicking on the arrow to verify with a green checkmark
4. Save and Add Custom Tool to Assistant

​

3. Add Prompt in AI Assistant to Collect Address

1. Add a prompt instructing the assistant to ask the user for their full address (e.g., “Could you please provide your full address, including the zip code?”)
2. Configure the assistant to call the Save Address function once the address is collected

​

4. Create Workflow to Map Address Fields in CRM

​

Return to the CRM Automation Tab

​

Fetch Sample Request

1. In the automation settings, select Fetch Sample Request to pull sample data
2. When the data mapping reference appears, save the trigger

​

Map Address Data to Contact Fields

1. Delete Default Action (e.g., Create Contact) if it appears automatically
2. Add Find Contact Action:
   • Choose Find Contact by Contact ID
   • Use the Contact_ID with the underscore (e.g., contact_id) from the inbound webhook trigger
3. Add Field Mapping for Address:
   • Select Update Contact Field for each part of the address: Street Address:
     • Go to Inbound Webhook > Arguments > Street
     City:
     • Go to Inbound Webhook > Arguments > City
     State:
     • Go to Inbound Webhook > Arguments > State
     Postal Code:
     • Go to Inbound Webhook > Arguments > Zip Code

​

Save and Publish Workflow

• Save the workflow and publish it to activate the custom tool

​

5. Testing and Validation

​

Test the Assistant Workflow

1. Place a test call or interaction with the AI assistant
2. Provide the address details when prompted by the assistant
3. Confirm that the assistant verifies and confirms the address

​

Review Data in CRM

1. After the test interaction, go to the Contacts tab in the CRM
2. Confirm that the address has been correctly saved in the General Info section of the contact profile under Street Address, City, State, and Postal Code

​

Implementation Example

​

Address Collection Flow

1. User Interaction: “I’d like to schedule a roof inspection”
2. AI Response: “I’d be happy to help you schedule a roof inspection. Could you please provide your full address, including the zip code?”
3. User Provides: “123 Main Street, Springfield, Illinois, 62701”
4. AI Processing: Calls Save Address tool with parsed parameters:
   Copy

   {
     "street": "123 Main Street",
     "city": "Springfield", 
     "state": "Illinois",
     "zip_code": "62701"
   }
   

5. CRM Update: Address automatically saved to contact profile

​

Key Benefits

• ✅ Automated data entry eliminates manual address input
• ✅ Standardized format ensures consistent address storage
• ✅ Real-time processing with immediate CRM updates
• ✅ Error reduction through structured data collection
• ✅ Seamless integration with existing CRM workflows
• ✅ Scalable solution adaptable to other data collection needs

​

FAQs

​

What if the address data doesn’t save in the correct fields?

​

Can this process be adapted for other data fields?

​

What if the assistant does not capture the address correctly?

​

Troubleshooting

• Verify custom tool is linked to assistant
• Check prompt configuration for tool activation
• Test webhook endpoint connectivity

• Review field mapping in workflow actions
• Ensure parameter names match webhook arguments
• Test with sample data to verify mapping

• Confirm webhook URL is correct and accessible
• Check authentication requirements
• Verify CRM permissions for contact updates

​

Summary