FieldTypeDescription
idstringUnique alphanumeric identifier for the object. The prefix of the Conversation ID is CVR-.
objectstringString representing the object’s type. Objects of the same type share the same value. The value here is conversation.
creation_timetimestampThe time the conversation was created.
initiated_bystringEither bot (auto reach out) or contact (website visitor clicked on a CTA)
last_updated_timestringThe date and time the conversation was last updated.
contactstring, expandableThe contact / customer involved in this conversation.
ownerstring, expandableThe owner (user object) of the conversation.
statusstringThe status of the conversation. Can be one of the following:
reached_out - When the bot has sent the reach out message, but the website visitor has not responded.
started - The website visitor has responded with a first message and the conversation is active from this point.
closed - The conversation has been closed, this can be done by the conversation ending with a last message, or the visitor starting a different conversation.
abandoned - If there is no response from the visitor for more than 10 minutes the conversation is ended in an abandoned state.
botstring, expandableThe bot that facilitated the conversation.
websitestring, expandableThe website this conversation was triggered on.
audiencestring, expandableThe audience associated with this conversation.

The website object

FieldTypeDescription
idstringUnique alphanumeric identifier for the object. The prefix of the Website ID is WEB-.
objectstringString representing the object’s type. Objects of the same type share the same value. The value here is website.
namestringThe name of the website.
urlstringThe URL of the website.

The audience object

FieldTypeDescription
idstringUnique alphanumeric identifier for the object. The prefix of the Audience ID is AUD-.
objectstringString representing the object’s type. Objects of the same type share the same value. The value here is audience.
namestringThe name of the audience.

The bot object

FieldTypeDescription
idstringUnique alphanumeric identifier for the object. The prefix of the Bot ID is BOT-.
objectstringString representing the object’s type. Objects of the same type share the same value. The value here is bot.
namestringThe name of the bot.

CONVERSATION

The following is an example of a conversation object.
{
  "object": "conversation",
  "id": "CVR-022EAEA41C",
  "creation_time": "2021-07-13T12:28:24Z",
  "initiated_by": "contact",
  "last_updated_time": "2021-07-13T12:33:54Z",
  "contact": "CTC-9QEG09XXYN",
  "owner": "USR-GNSBE50D6A",
  "status": "closed",
  "website": "WEB-B1D45D12BB",
  "audience": null,
  "bot": "BOT-62774A40FB"
}