POST
/
bc
/
v1
/
events
/
event
/
start-conversation
Start a conversation
curl --request POST \
  --url https://app.mindlytics.ai/bc/v1/events/event/start-conversation \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-ID: <api-key>' \
  --data '{
  "session_id": "<string>",
  "timestamp": "<string>",
  "user_id": "<string>",
  "device_id": "<string>",
  "type": "track",
  "event": "Conversation Started",
  "conversation_id": "<string>",
  "properties": {},
  "attributes": {}
}'
[
  {
    "type": "start_session"
  }
]

Authorizations

​
Authorization
string
header
required

API Key for your organization

​
X-App-ID
string
header
required

Project ID

Body

application/json
​
session_id
string
required

A unique session ID generated by caller

​
type
enum<string>
required

The event that tracks an arbitray event

Available options:
track
​
event
enum<string>
required

The event that starts a conversation

Available options:
Conversation Started
​
conversation_id
string
required

The ID of the conversation

​
timestamp
string

The timestamp of the event, defaults to "now" if not specified.

​
user_id
string

The unique ID of the user

​
device_id
string

The ID of the device, if applicable

​
properties
object

Any additional properties to be associated with the event

​
attributes
object

Any additional attributes to be associated with the conversation

Response

200 - application/json

Success

The events that were generated by the Mindlytics service as a result of this event.

​
type
enum<string>
required

The type of event being sent.

Available options:
start_session,
end_session,
identify,
alias,
track
​
{key}