Eventos de Chat

Os eventos de chat possibilitam avisar o RD Station sempre que um contato inicia ou termina uma conversa via chat. Assim sendo, os apps integrados precisam apenas disparar as chamadas a API do RD Station no momento desejado.

Evento de Início da Conversa

O RD Station Marketing considera sempre o valor do atributo event_type CHAT_STARTED como identificador do evento customizado. Esse evento é registrado sempre que ocorre o início de uma conversa em um chat.

POST https://api.rd.services/platform/events

Request body parameters

Field	Type	Required	Description
event_type	String	true	The event type that diferentiates the event. For the chat started event it should be sent as "CHAT_STARTED".
event_family	String	true	The family of the event for processing purposes. It currently accepts only "CDP" as valid option.
chat_subject	String	true	The subject of the chat.
cf_chat_status	String	true	Status of the chat.
cf_chat_type	String	false	Type of the chat.
cf_birthdate	String	false	Bith date of the Contact
cf_gender	String	false	Gender of the Contact.
name	String	false	Name of the contact.
email	String	true	Email of the contact.
job_title	String	false	Job title of the contact.
personal_phone	String	false	Phone of the contact.
mobile_phone	String	false	Mobile phone of the contact.
twitter	String	false	Twitter handler of the contact.
facebook	String	false	Facebook of the contact.
linkedin	String	false	Linkedin of the contact.
website	String	false	Website of the contact.
company_name	String	false	Company name of the contact.
company_site	String	false	Company website of the contact.
legal_bases	Array of Objects	false	Legal Bases of the contact.

Request body example

{
  "event_type": "CHAT_STARTED",
  "event_family":"CDP",
  "payload": {
    "name": "Name of the contact",
    "email": "[email protected]",
    "company_name": "Company name of the contact",
    "company_site": "Company website of the contact",
    "job_title": "Job title of the contact",
    "personal_phone": "Phone of the contact",
    "mobile_phone": "Mobile phone of the contact",
    "twitter": "Twitter handler of the contact",
    "facebook": "Facebook of the contact",
    "linkedin": "Linkedin of the contact",
    "website": "Website of the contact",
    "chat_subject": "Chat subject",
    "cf_birthdate": "1980-06-10",
    "cf_gender": "Gender of the Contact",
    "cf_chat_status": "online",
    "cf_chat_type": "Type of the chat: sales, support, ...",
    "legal_bases": [
      {
        "category": "communications",
        "type": "consent",
        "status": "granted"
      }
    ]
  }
}

Legal Bases

Field	Type	Valid Params
category	String	communications
type	String	pre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
status	String	granted or declined

Evento de Término da Conversa

O RD Station Marketing considera sempre o valor do atributo event_type CHAT_FINISHED como identificador do evento customizado. Esse evento é registrado sempre que ocorre o término de uma conversa em um chat.

POST https://api.rd.services/platform/events

Request body parameters

Field	Type	Required	Description
event_type	String	true	The event type that diferentiates the event. For the chat finished event it should be sent as "CHAT_FINISHED".
event_family	String	true	The family of the event for processing purposes. It currently accepts only "CDP" as valid option.
chat_subject	String	true	The subject of the chat.
cf_chat_status	String	true	Status of the chat.
cf_chat_type	String	false	Type of the chat.
cf_birthdate	String	false	Bith date of the Contact
cf_gender	String	false	Gender of the Contact.
name	String	false	Name of the contact.
email	String	true	Email of the contact.
job_title	String	false	Job title of the contact.
personal_phone	String	false	Phone of the contact.
mobile_phone	String	false	Mobile phone of the contact.
twitter	String	false	Twitter handler of the contact.
facebook	String	false	Facebook of the contact.
linkedin	String	false	Linkedin of the contact.
website	String	false	Website of the contact.
company_name	String	false	Company name of the contact.
company_site	String	false	Company website of the contact.
legal_bases	Array of Objects	false	Legal Bases of the contact.

Request body example

{
  "event_type": "CHAT_FINISHED",
  "event_family":"CDP",
  "payload": {
    "name": "Name of the contact",
    "email": "[email protected]",
    "company_name": "Company name of the contact",
    "company_site": "Company website of the contact",
    "job_title": "Job title of the contact",
    "personal_phone": "Phone of the contact",
    "mobile_phone": "Mobile phone of the contact",
    "twitter": "Twitter handler of the contact",
    "facebook": "Facebook of the contact",
    "linkedin": "Linkedin of the contact",
    "website": "Website of the contact",
    "chat_subject": "Chat subject",
    "cf_birthdate": "1980-06-10",
    "cf_gender": "Gender of the Contact",
    "cf_chat_status": "online",
    "cf_chat_type": "Type of the chat: sales, support, ...",
    "cf_chat_transcript_message": "Transcript of the chat",
    "legal_bases": [
      {
        "category": "communications",
        "type": "consent",
        "status": "granted"
      }
    ]
  }
}

Legal Bases

Field	Type	Valid Params
category	String	communications
type	String	pre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
status	String	granted or declined