Connect to AI Agent

POST

https://app.trypeach.io/api/v1/events

Connect to an AI Agent by sending a template message to a contact. The WhatsApp template should be approved for this API to work.

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params application/json

Examples

Connect to AI AgentConnect to AI Agent with retries configured

Note that the template message isn't retried by default in case of delivery failures.

{
    "event_type": "connect_to_ai_agent",
    "contact": {
        "name": "John Doe",
        "email": "johndoe@example.com",
        "phone_number": "+919988776655"
    },
    "template_message": {
        "whats_app_template_id": "wat_1234abcd",
        "liquid_values": {
            "account_name": "Foo",
            "cta1": "Bar"
        }
    },
    "ai_agent": {
        "id": "aiflw_1234abcd"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Connect to AI AgentConnect to AI Agent with retries configured

curl --location --request POST 'https://app.trypeach.io/api/v1/events' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event_type": "connect_to_ai_agent",
    "contact": {
        "name": "John Doe",
        "email": "johndoe@example.com",
        "phone_number": "+919988776655"
    },
    "template_message": {
        "whats_app_template_id": "wat_1234abcd",
        "liquid_values": {
            "account_name": "Foo",
            "cta1": "Bar"
        }
    },
    "ai_agent": {
        "id": "aiflw_1234abcd"
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": "success",
    "event_id": "string"
}

Modified at 2025-10-14 05:04:44

Poll template messages status

Send an App message