Conversica website chat doesn’t just engage your visitors—it helps you turn them into leads, fast. With the Conversica API integration, you can automatically push those leads to your systems in real time. This guide walks you through how to set up a webhook endpoint to receive those leads. Inside, you’ll find all the technical specifications you need—including required fields and response formats—to ensure a smooth and reliable integration.
Webhook Endpoint Requirements
Conversica's lead creation webhook requires a publicly accessible URL that can receive POST requests. Similar to the standard Conversica API message and lead update webhook requirements, basic authentication (username and password) is mandatory for this webhook. For security, the webhook should utilize HTTPS. Lead data will be sent in JSON format within the request body.
Example Customer Endpoint
https:// api.customername.com /conversicaCreate/
OR https:// api.customername.com/conversica/create*You will want to use the same endpoint URL format you have in place for your Conversica Lead and Message endpoints.
Fields Sent by Conversica
Conversica will send the following fields in the JSON payload. Additional custom fields are available upon request:
| Field Name | Data Type | Description | Required? |
|---|---|---|---|
| firstName | String | First name of the lead | Yes |
| lastName | String | Last name of the lead | Yes |
| String | Email address of the lead | Yes | |
| conversationHistory | String | Transcript of the chat conversation | Yes |
| clientId | String | ID of the client in the partner's system | Only for provider-style integrations |
Example Payload
{
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"conversationHistory": "2025-05-23T11:40:07 John Doe: I'm interested in your product.\n2025-05-23T11:40:11 Conversica (Assistant): Great! Let me get some details..."
}
Expected Response Status Codes and Messages
The webhook endpoint must respond with a JSON object containing the fields "status" and "message," with the status field including one of the following specified status codes:
- 200 OK: Lead received successfully.
- 400 Bad Request: Invalid request data.
- 401 Unauthorized: Invalid credentials.
- 500 Internal Server Error: An error occurred on the server.
Example Successful Response
{
"status": "200",
"message": "Lead received successfully"
}
Example Error Response
{
"status": "400",
"message": "Missing required field: email"
}
Comments
0 comments
Article is closed for comments.