API Trigger

The API Trigger node lets you initiate outbound calls to your voice agent programmatically. When you add an API Trigger node to your workflow, Peachdesk generates a unique endpoint URL that external systems can call to start a conversation. This is useful when you want to trigger calls from your own backend, a CRM, or workflow tools like n8n and Zapier.

Prerequisites

A configured telephony provider — outbound calls will fail without one
An API key for authentication

Finding your trigger URL

When you add an API Trigger node to your workflow, Peachdesk assigns it a unique UUID. The trigger node exposes two URLs that share this UUID:

A production URL for the published workflow
A test URL for the latest draft

You can copy either URL from the trigger node’s settings dialog.

POST https://your-peachdesk-instance/api/v1/public/agent/{uuid}        # Production
POST https://your-peachdesk-instance/api/v1/public/agent/test/{uuid}   # Test

If you are using the hosted version, replace your-peachdesk-instance with api.peachdeskai.com.

Test vs production

Mode	URL	Runs
Production	`/api/v1/public/agent/{uuid}`	The published version of the agent.
Test	`/api/v1/public/agent/test/{uuid}`	The latest draft. Falls back to the published version if no draft exists.

Use the test URL while iterating on changes so production traffic continues to hit the published version. The production URL only executes a published workflow. If you update the workflow but do not publish it, the production trigger will continue to run the older published version. Once you publish your draft, both URLs run the same definition.

A common pitfall is editing the workflow, saving the draft, and then calling the production trigger URL expecting the new behavior. That will not work until you publish the workflow. Use the test URL to verify draft changes before publishing.

The request body, headers, and response shape are identical for both URLs.

Making a request

Authenticate by passing your API key in the X-API-Key header. The request body requires a to_number and accepts optional initial_context and telephony_configuration_id fields.

curl -X POST https://your-peachdesk-instance/api/v1/public/agent/{uuid} \
  -H "Content-Type: application/json" \
  -H "X-API-Key: bibha_your_api_key" \
  -d '{
    "to_number": "+14155550100",
    "initial_context": {
      "customer_name": "Jane",
      "appointment_date": "March 15"
    }
  }'

curl -X POST https://your-peachdesk-instance/api/v1/public/agent/test/{uuid} \
  -H "Content-Type: application/json" \
  -H "X-API-Key: bibha_your_api_key" \
  -d '{
    "to_number": "+14155550100",
    "initial_context": {
      "customer_name": "Jane",
      "appointment_date": "March 15"
    }
  }'

Use the test URL when you want to verify draft changes before publishing.

Response

A successful request returns a workflow_run_id that you can use to retrieve call details, recordings, and transcripts. It also returns a call_id — the identifier echoed as call.call_id on the outbound webhook, so you can correlate the webhook event with this call.

{
  "status": "initiated",
  "workflow_run_id": 12345,
  "workflow_run_name": "WR-API-7823",
  "call_id": "12345"
}

Error responses

Status	Cause
`400`	Telephony provider not configured, or call failed to initiate
`401`	Missing or invalid API key
`403`	API key does not have access to this agent
`404`	Trigger not found or not active

Initial context

initial_context is a JSON object containing any information you want your voice agent to access during the call. You can reference these values in your prompts using dynamic variables — values enclosed in {{ and }}.

You can pass the same data as dynamic_variables — a flat string map that merges into initial_context. See Passing dynamic variables via the API.

For example, if your request includes:

{
    "to_number": "+14155550100",
    "initial_context": {
        "user": {
            "name": "John"
        }
    }
}

You can reference the user’s name in your prompt as {{initial_context.user.name}}. See Context & Variables for more on how data flows through a call.

Correlating calls with webhooks

Pass a metadata object to attach your own correlation keys to the call. Peachdesk stores it and echoes it back unchanged as call.metadata on the outbound event webhook, alongside the call_id returned in the response.

{
  "to_number": "+14155550100",
  "dynamic_variables": { "customer_name": "Jane" },
  "metadata": { "crm_id": "cus_8842" }
}

When the webhook arrives, match call.call_id against the call_id from this response (or read your own key out of call.metadata) to tie the event back to the call you triggered.

Choosing a telephony configuration

By default, calls are placed through your organization’s default outbound telephony configuration. To route a specific call through a different configuration — for example, to dial out from a regional number — pass telephony_configuration_id in the request body.

{
  "to_number": "+14155550100",
  "telephony_configuration_id": 42
}

The id is shown on each row in Telephony configurations (https://app.peachdeskai.com/telephony-configurations for hosted or http://localhost:3010/telephony-configurations for local). The configuration must belong to the same organization as the API Trigger; otherwise the request returns 404.

For full endpoint details including all parameters and response fields, see the API reference.

Getting started

Core Concepts

Configurations

Voice Agent Builder

Telephony

Integrations

Voice Studio

Prerequisites

Finding your trigger URL

Test vs production

Making a request

Response

Error responses

Initial context

Correlating calls with webhooks

Choosing a telephony configuration

​Prerequisites

​Finding your trigger URL

​Test vs production

​Making a request

​Response

​Error responses

​Initial context

​Correlating calls with webhooks

​Choosing a telephony configuration

Prerequisites

Finding your trigger URL

Test vs production

Making a request

Response

Error responses

Initial context

Correlating calls with webhooks

Choosing a telephony configuration