This API allows external partners to trigger a Standalone Welcome Call by sending customer information directly to the system.

Once the POST request is received, the platform responds with a survey URL that can be shared with the customer.

GET vs POST Flow:

GET flow:

You need to build and maintain a secure webhook. Our platform will call this webhook with session-specific parameters (session_id, token_id), and your system must respond with the customer data (e.g., name, email).

Note- You are responsible for generating survey URL on your platform.

Request Payload (Sent by Welcome Call)

json
CopyEdit
{
  "token_id": "<UUID>",           // Required – Unique customer identifier used to fetch data
  "interaction_id": "<string>"    // Required – Session or customer identifier
}

Expected Response (From CRM)

Your webhook should return a JSON object containing required customer fields for the survey:

json
CopyEdit
{
  "first_name": "Test",
  "last_name": "Test",
  "email": "test@email.com",
  "state": "California",
  "deal_type": "Cash"
}

Additional fields may be required based on the Webhook Fields configured in your Welcome Call setup.

POST flow:

You simply push the customer data to our platform by calling the POST API endpoint.

As soon as we receive the payload, we: