Built-in functions for WhatsApp agents

Reference for the built-in functions you can add to a WhatsApp AI agent, such as human handoff, tagging, notifications, calendar booking, and lead capture.

Built-in functions give a WhatsApp AI Agent ready-made actions. The agent decides when to call each function from its description, so write the description to say when it applies.

You add all functions from the Functions tab of a WhatsApp AI Agent. Select Add Function and choose a type from the list.

Functions you can add

Function	What it does
API Function	Calls your REST API. See API function.
CSV Function	Searches an uploaded CSV file. See CSV function.
Shopify Function	Looks up a Shopify order. See Shopify function.
WhatsApp Function	Sends an approved template. See WhatsApp function.
Assign to Human Agent	Hands the conversation to a team member.
Tag Contact	Adds tags to the customer's contact.
Send WhatsApp Notification	Sends a template to your own team numbers.
Google Calendar Booking	Checks availability, books, and reschedules meetings.
Jump to Flow	Hands the conversation to a Flow Agent.
Compare Dates	Compares a date with today.
Card Lead Capture	Saves a lead from a business card or ID card image.
Voice Note Lead	Saves a lead from a voice note.
Text Lead Capture	Saves a lead from details typed in chat.
Check Contact Exists	Checks whether a contact exists.
Find Contact by Field	Finds a contact by a stored value.

Assign to Human Agent

The agent calls this function when it cannot answer or when the customer asks for a person. Kipps.AI turns on manual reply mode for the conversation, so the agent stops replying, and assigns the conversation to a team member. It then emails the assignee. The customer sees a message that the team will follow up.

Setting	What to enter
Description	When the agent should hand off.
Assignment Mode	Round Robin rotates between the members you choose. Specific Person always assigns the same member.
Rotate Between	For Round Robin, one or more team members.
Assign To	For Specific Person, a team member.

Members with the viewer or billing role are not listed. The assignee opens the conversation from the Inbox.

Tag Contact

Adds the tags you configure to the contact for the current conversation. If the contact does not exist yet, Kipps.AI creates it from the customer's number.

Setting	What to enter
Function Name	A unique name with letters, numbers, and underscores, for example `tag_hot_lead`.
When should the AI call this?	The condition, for example "when the user confirms purchase intent".
Tags to apply	Select existing tags, or type a new name and press Enter.

Send WhatsApp Notification

Sends an approved template to fixed WhatsApp numbers, for example to alert your sales team about a new lead.

Setting	What to enter
Function Name and Description	The name, and when the agent should send the alert.
Send notification from	Kipps.AI number, or My connected WhatsApp number.
Send from number	For your own number, the connected number to use.
Notify these WhatsApp numbers	Up to 10 numbers with country code, for example `919876543210`.
WhatsApp Template	The approved template to send.
Parameters	Fixed values, or descriptions that tell the agent how to fill each value.

Sending from the Kipps.AI number costs 1 credit per message, per number.
Each conversation can trigger up to 20 notification messages per hour.

Google Calendar Booking

Sets up booking in one step. It creates three functions: check availability, book an appointment, and reschedule an appointment.

Select Connect Google Account if no account is connected, or choose one in Select Connected Google Account.
Choose a Time Zone. The default is Asia/Kolkata.
Enter the Meeting Duration (mins). The default is 30.
Optionally add Zoom/Teams link or other meeting details. Kipps.AI sends it with the Google Meet link in every invite.
Save the setup.

To book, the agent collects the customer's name, email, phone number, date, and time. If the agent already has booking functions, Kipps.AI warns you so that you do not create a duplicate set.

Jump to Flow

Hands the conversation to a Flow Agent and continues from a node you choose.

Setting	What to enter
Function Name	A unique name, for example `jump_to_order_flow`.
When should the AI call this?	The condition, for example "when the user wants to track an order".
Target Flow Agent	The Flow Agent to hand off to.
Land on Node	The node where the flow resumes.
Execute the node immediately	If selected, the node runs right away. Otherwise it runs on the customer's next message.

After the handoff, the Flow Agent handles the customer's messages.

Compare Dates

Compares a date with today so the agent does not guess. Use it before booking, for example, to refuse a past date.

Setting	What to enter
Function Name	For example `check_if_past_date`.
Description	Optional. A default description is used when empty.
Time Zone	The time zone used for every comparison.

The agent passes a date and, optionally, a time. The function returns the number of days between that date and today. A negative number means the date has passed, 0 means today, and a positive number means a future date. When you pass a time, it also returns the difference in minutes and whether the moment is in the past.

Lead capture and contact lookup

These four functions work on your Contacts. They are meant for your own team, for example a salesperson who sends a business card photo or a voice note to the agent.

Each function has an Allowed Numbers list. Only messages from those WhatsApp numbers can use the function, so include the country code. For any other sender, the agent continues the conversation normally and does not mention leads.

Function	What it does
Card Lead Capture	Saves the details from a business card or ID card image as a contact. A readable phone number is required.
Voice Note Lead	Saves a lead from a voice note transcript, given a phone number. It creates the contact, or adds the summary to the existing contact's `lead_notes` field with the date.
Text Lead Capture	Saves a lead from contact details typed in chat. It is not used for voice notes.
Check Contact Exists	Checks by phone number or name whether a contact exists, without changing anything. Use it before a lead function when you only have a name.

The three lead functions also have these settings:

Setting	What to enter
Lead Tag	The tag added to saved contacts. The default is `lead`.
Extra Fields	Extra custom field names to capture beyond name, phone, and email. The defaults are `company`, `designation`, `address`, `website`, and `other_details`.
Lead Source	The source recorded on the contact. The default is `WHATSAPP`.

Kipps.AI creates the extra fields as text custom fields. If the contact already exists, it keeps the existing name and email and updates the extra fields. Voice note leads need the Enable Voice notes support switch on the AI tab.

Find Contact by Field

Looks up stored information about the customer using a value they give, such as a registration number or order ID.

Setting	What to enter
Function Name	For example `find_contact_by_field`.
Description	Optional. A default description is used when empty.

The agent passes a field name and the value the customer gave. Kipps.AI finds the contact whose custom field has that value, or has it as one item in a list separated by |, and returns that contact's custom fields. If more than one contact matches, the agent asks the customer for another detail such as a phone number. See Custom fields.

Manage functions

The Functions tab lists every function with its name and type. Use the pencil icon to edit and the bin icon to delete.

Troubleshoot

The agent never calls a function. Rewrite the description to name the situations that should trigger it.

Lead functions do nothing for a sender. Check that the sender's number is in Allowed Numbers, with the country code.

Notifications stop after a while. Each conversation is limited to 20 notification messages per hour. With the Kipps.AI number, also check your credit balance.