API Reference

Create programmable call flow

post
https://api.whippy.co/v1/call_flows

Creates a programmable Call Flow (webhook_config.url required).

Optional channel_id assigns one organization channel (1 channel ↔ 1
programmable Call Flow). Static IVR (ivr_flow_config) is not
supported on the Public API.

After create, Whippy POSTs telephony events to webhook_config.url and
executes the single inline action you return. See the
programmableCallFlowWebhook callback for the runtime request/response
schemas (events include forward outcomes and terminal status-only
status.updated).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create Call Flow Params

Create a programmable Call Flow.

Required: webhook_config.url (non-blank HTTPS).

Optional: head fields, flags, voice, webhook_config.signing_api_key_id,
and channel_id (assigns one org channel; 1 channel ↔ 1 flow).

Additional / Private-only keys (e.g. ivr_flow_config, channel_ids) are
ignored.

uuid

Optional channel to assign to this Call Flow. Must belong to the
organization. Replaces any previous assignment for this flow.

string

Call Flow color (hex)

string

Call Flow description

string

Call Flow emoji

flags
object

Call Flow feature flags

string

Call Flow name

string

TTS voice language (BCP-47)

string

TTS voice type

webhook_config
object
required

Programmable webhook config. Required on create (url must be non-blank HTTPS).
Optional signing_api_key_id HMAC-signs outbound POSTs (X-Whippy-Signature).

Responses

Callback

Updated about 2 hours ago

Did this page help you?
Language
Credentials
LoadingLoading…
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?