- Outbound: an automation with the Send to Zapier action POSTs the conversation to a Zapier Catch Hook. You store the hook URL on Integrations, then pick that connection in the automation.
- Inbound: a Zap calls Botcadence with a project API key to place a campaign call or start automations.
Prerequisites
- A Zapier account
- Permission to add integrations and, for inbound Zaps, to create a project API key
- For outbound: a Zap that starts with Webhooks by Zapier → Catch Hook
Connect (outbound Catch Hook)
1
Create a Catch Hook in Zapier
Create a Zap. Choose Webhooks by Zapier → Catch Hook. Copy the webhook URL.
2
Save the URL in Botcadence
In the project sidebar, select Integrations, then Add Integration. Select Connect on Zapier. Paste Zapier Catch Hook URL (HTTPS). The wizard checks that the URL uses HTTPS.
3
Create a Zapier automation
Open Automations and select Create automation. Under What starts it, pick a conversation event, for example Conversation or call finished. Under What to do, pick Send to Zapier, then this connection. Optionally add Push conditions so it sends only when a captured field matches. It runs everywhere; switch it off for one place on that campaign, inbound line, or channel’s Automations tab.
After a real conversation where the automation runs, the Catch Hook receives the event payload. The automation’s run history shows whether the step was delivered.
structured_data. Apart from the fields its push conditions check, Zapier doesn’t pull out fields of its own: the rest come from your other automations, such as a Google Sheets, CRM, or conversation report action. To also add a Google Sheets row or update a CRM, create another automation on the same event.
Outbound events
The payload is named after the event that started the automation, for example:conversation.completedconversation.handoverconversation.inactivity_summary
event, event_type (compat alias), occurred_at, organization_id, project_id, conversation_id, customer_profile_id, conversation_type, channel, status, summary.
Handover events also include handover_id, handover_reason, handover_status, and user_message.
Map those fields in Zapier to Gmail, Sheets, your CRM, or any other Zap step.
Inbound Zaps (call Botcadence)
1
Create a project API key
Create a key under API keys with the scope you need.
2
POST from Zapier
In Zapier, use Webhooks by Zapier → POST. Add the header
Authorization: Bearer YOUR_PROJECT_API_KEY. Do not put the key in the Zap URL.- Create an outbound campaign call:
POST /organizations/{org_id}/projects/{project_id}/campaigns/{campaign_id}/calls(scopecalls:create) - Start the automations that use Your system (webhook) as the trigger:
POST /organizations/{org_id}/projects/{project_id}/automation-rules/trigger(scopeautomations:create). Send the automation’s event name asevent. - Send a WhatsApp message through a broadcast:
POST /organizations/{org_id}/projects/{project_id}/broadcasts/{broadcast_id}/messages(scopewhatsapp:create)
https://backend.botcadence.com (production). See Authentication and Create outbound call.
Limits
- The Catch Hook must be HTTPS.
- No events go to Zapier until an automation sends to this connection.
- Zapier is a Catch Hook, not a CRM field mapper: map the fields in your Zap.
Troubleshooting
Zapier never receives events
Zapier never receives events
Confirm the Catch Hook URL is saved on Integrations, an automation that is on sends to this connection, and the automation runs where the conversation happened. Open the automation’s runs to see each delivery and any error.
Catch Hook URL is rejected
Catch Hook URL is rejected
Paste the full HTTPS URL from Webhooks by Zapier. HTTP URLs are not accepted.
Inbound Zap returns 401
Inbound Zap returns 401
Use the header
Authorization: Bearer YOUR_PROJECT_API_KEY with a live project key. Confirm the key matches the organization and project in the URL and has the resource scope required by the endpoint: calls:create, automations:create, or whatsapp:create.
