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.

Request body parameters
FieldTypeRequiredDescription
event_typeStringtrueThe event type that diferentiates the event. For the chat started event it should be sent as "CHAT_STARTED".
event_familyStringtrueThe family of the event for processing purposes. It currently accepts only "CDP" as valid option.
chat_subjectStringtrueThe subject of the chat.
cf_chat_statusStringtrueStatus of the chat.
cf_chat_typeStringfalseType of the chat.
cf_birthdateStringfalseBith date of the Contact
cf_genderStringfalseGender of the Contact.
nameStringfalseName of the contact.
emailStringtrueEmail of the contact.
job_titleStringfalseJob title of the contact.
personal_phoneStringfalsePhone of the contact.
mobile_phoneStringfalseMobile phone of the contact.
twitterStringfalseTwitter handler of the contact.
facebookStringfalseFacebook of the contact.
linkedinStringfalseLinkedin of the contact.
websiteStringfalseWebsite of the contact.
company_nameStringfalseCompany name of the contact.
company_siteStringfalseCompany website of the contact.
legal_basesArray of ObjectsfalseLegal 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
FieldTypeValid Params
categoryStringcommunications
typeStringpre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
statusStringgranted 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.

Request body parameters
FieldTypeRequiredDescription
event_typeStringtrueThe event type that diferentiates the event. For the chat finished event it should be sent as "CHAT_FINISHED".
event_familyStringtrueThe family of the event for processing purposes. It currently accepts only "CDP" as valid option.
chat_subjectStringtrueThe subject of the chat.
cf_chat_statusStringtrueStatus of the chat.
cf_chat_typeStringfalseType of the chat.
cf_birthdateStringfalseBith date of the Contact
cf_genderStringfalseGender of the Contact.
nameStringfalseName of the contact.
emailStringtrueEmail of the contact.
job_titleStringfalseJob title of the contact.
personal_phoneStringfalsePhone of the contact.
mobile_phoneStringfalseMobile phone of the contact.
twitterStringfalseTwitter handler of the contact.
facebookStringfalseFacebook of the contact.
linkedinStringfalseLinkedin of the contact.
websiteStringfalseWebsite of the contact.
company_nameStringfalseCompany name of the contact.
company_siteStringfalseCompany website of the contact.
legal_basesArray of ObjectsfalseLegal 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
FieldTypeValid Params
categoryStringcommunications
typeStringpre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
statusStringgranted or declined