Triggering a VoiceAgent Call from Zapier

• Admin

​

CloudTalk VoiceAgents in Zapier

​

Prerequisites

• CloudTalk API Credentials
  • Go to CloudTalk Dashboard → Settings → API Keys
  • Copy both the API Key ID and API Key Secret
• VoiceAgent ID
  • VoiceAgent ID can be retrieved from Cloudtalk Dashboard > AI Voice Agents
  

​

Setup Instructions

1. In the Zap of your choice, add an Action step and choose Webhooks by Zapier.
2. Choose Custom Request as the action event.
3. For Method select POST
4. For API Endpoint use this URL:
   https://api.cloudtalk.io/v1/voice-agent/calls
5. In Data configure body of request according to API documentation
   • Create a JSON payload using the following format:
     {
     "call_number": "#{{phone_number}}",
     "voice_agent_id": "#{{voice_agent_id}}",
     "call_properties": {
     "system_prompt": {
     "variables": {
     "contact_name": "#{{name}}"
     }
     },
     "output": {
     "variables": {
     "custom_field": "value"
     }
     }
     }
     }
     
   • Replace the variables (#{{...}}) with data from earlier steps in your scenario.
   • In call_number, insert a reference to the phone number (e.164) to be called, extracted from previous steps.
   • In voice_agent_id, insert the ID of the VoiceAgent obtained from the CloudTalk Dashboard.
   • If necessary, configure call_properties, where:
     1. Data in call_properties.system_prompt.variables includes request-specific information the VoiceAgent should use during the call (e.g. the contact’s name).
     2. Data in call_properties.output.variables defines the values VoiceAgent should pass to the external endpoint after the call, in addition to information extracted during the conversation.
   

6. In the Headers field, add the header "Content-Type": "application/json"
7. Set up Basic Authentication using your API Key ID as the username and API Key Secret as the password, both taken from the CloudTalk Dashboard.
8. Click Continue, and if you’d like to verify the setup, use Test Step to send a test call.