1
Find Your Agent ID

Go to My Agents, click on your welcome call agent, and note the ID from the URL: voiceship.polsia.app/agent/7

You'll include this ID in every webhook call so VoiceShip knows which agent (and which welcome message template) to use.

2
Webhook Endpoint

Make a POST request to this URL whenever a new user signs up on your platform:

POST

Request body (JSON):

Field Type Required Description
phone_number string Required Customer's phone number in E.164 format (e.g. +15550001234)
agent_id integer Required Your VoiceShip agent ID (from Step 1)
customer_name string Optional Customer's name โ€” used to personalize the welcome message ({{customer_name}})
Success Response (200)
{ "success": true, "call_log_id": 42, "status": "initiated", // or "pending_pipecat_setup" until Pipecat is live "session_id": "pipecat-session-abc123", "message": "Welcome call initiated." }
3
Add to Your Signup Flow

Copy the snippet for your platform and add it to your post-signup handler. The call fires in the background โ€” your signup flow won't be blocked.

๐Ÿ’ก

Fire and forget: Call this endpoint asynchronously (don't await it in your user-facing flow). The welcome call happens in the background โ€” your signup completes instantly.

Test Your Webhook

Use this form to fire a test call right now and confirm your configuration is working: