Skip to main content
An integration connects an action in your system with ContactShip data or actions. Start by deciding who initiates the process and when you need the result.

​
Choose an entry point

My system starts the action

Use the API to create contacts, start calls, send messages, or query records.

ContactShip notifies my system

Receive results or events through a webhook. Each type has its own configuration and payload.

The agent needs my system

Configure an HTTP tool to read or update data during a conversation.

I want to automate follow-ups

Choose a call-result workflow, an inbox rule, or text-agent follow-ups.

​
Walkthrough: from your CRM to a call result

1

Identify the organization and records

Generate or copy the API key. Find the contact, agent, and outbound number in the same organization.
2

Configure the result destination

Open the voice agent’s Advanced → Post-call, configure the outgoing webhook URL, and publish. Prepare your receiver before starting the call.
3

Start the call and store its ID

Use Call a contact or Call a number. Store the response’s data.call_id alongside your CRM ID. Request acceptance does not contain the final call result.
4

Process analysis and verify the action

The webhook arrives after analysis. Match data.call.call_id to your record, inspect the result, and update your system. Check delivery in Calls → Webhooks and execution in your receiver.
The call ID is at data.call_id in the creation response and data.call.call_id in the webhook. Store it to correlate both stages without relying on phone numbers.

​
Where to find each value

​
Choose where the integration runs

Keep the key on your server. Make HTTP requests to the API and expose a reachable URL for webhooks. Use the API reference for each operation’s exact fields.
Webhooks do not automatically forward every API field. The final call webhook does not include metadata. Keep the relationship between IDs in your own system.

​
Frequently asked questions

They work together. Your system can start a call through the API and receive its analysis through a webhook.
Find the event in Calls → Webhooks and query the call through the API. Before retrying, check whether your system already performed the action.
You can use n8n, Make, or inbox automations. You still need to define the trigger, data mapping, and error handling.

​
Continue with

Webhook types

Choose the event and find its configuration.

Automate follow-ups

Turn results into actions.