Skip to main content
Webhooks let your server react to events as they happen. Whenever mycpaas receives an inbound SMS or MMS, or whenever the status of a call changes, mycpaas sends an HTTP POST request to a URL you specify. Your server processes the payload and — for SMS — can reply with LaML XML to send a response message back to the caller.

Webhook types

mycpaas sends two categories of webhook events:
TypeWhen it fires
SMS webhookAn inbound SMS or MMS arrives on your mycpaas number
Voice webhookA call status changes (initiated, ringing, answered, completed, failed, etc.)
See the dedicated pages below for full payload details and handler examples.

How to configure a webhook URL

You can set a webhook URL in two ways: Per-request via StatusCallback — pass the StatusCallback parameter when you create a call or send a message through the API. This overrides the default for that specific request. Account default in the Dashboard — log in to the myCPaaS App, navigate to your number settings, and set a default webhook URL. mycpaas uses this URL for any request that does not include a StatusCallback parameter.
Your webhook endpoint must be publicly reachable over the internet and must respond with HTTP 200. mycpaas treats any other status code as a delivery failure and may retry the request.
During local development, your server is not publicly reachable by default. Use a tunneling tool like ngrok to expose a local port to the internet. Run ngrok http 3000 and use the generated HTTPS URL as your webhook URL.

Next steps

SMS webhooks

Handle inbound SMS and MMS messages and reply with LaML XML.

Voice webhooks

Track call status changes and respond to call events in real time.