Os eventos padrão são definidos especificamente para as transições padrão de um Contato em um funil do RD Station. Como por exemplo, eventos de conversão que levam um Contato para o estágio de Lead e eventos de marcação de oportunidade, won e lost.


Evento de Conversão

O RD Station Marketing considera o valor do atributo conversion_identifier como identificador do evento customizado. Esse evento é registrado sempre que ocorre uma conversão.

Request body parameters
FieldTypeRequiredDescription
event_typeStringtrueThe event type that diferentiates the event. For the conversion event it should be sent as "CONVERSION".
event_familyStringtrueThe family of the event for processing purposes. It currently accepts only "CDP" as valid option.
conversion_identifierStringtrueThe name of the conversion event.
nameStringfalseName of the contact.
emailStringtrueEmail of the contact.
job_titleStringfalseJob title of the contact.
stateStringfalseState of the contact.
cityStringfalseCity of the contact.
countryStringfalseCountry 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.
cf_custom_field_api_identifierStringfalseCustom field and its value related to the contact.
company_nameStringfalseCompany name of the contact.
company_siteStringfalseCompany website of the contact.
company_addressStringfalseCompany address of the contact.
client_tracking_idStringfalseValue of a '_rdtrk' cookie. (e.g: 43b00843-09af-4fae-bf9d-a0697640b808)
traffic_sourceStringfalseThis can either be the value of a '__trf.src' cookie (base 64 encoded or not) or an UTM source param. If passing a cookie the following fields MUST be empty: traffic_medium, traffic_campaign and traffic_value.
traffic_mediumStringfalseUTM medium param.
traffic_campaignStringfalseUTM campaign param.
traffic_valueStringfalseUTM value param (term).
tagsArray of StringsfalseTags that can be added to the contact.
available_for_mailingBooleanfalseEnable/disable receive emails.
legal_basesArray of ObjectsfalseLegal Bases of the contact.

Obs: All custom fields available in RD Station Marketing account are valid on this payload, and should be sent with the payload key as the api identifier (cf_api_identifier).


Request body example
{
  "event_type": "CONVERSION",
  "event_family":"CDP",
  "payload": {
    "conversion_identifier": "Name of the conversion event",
    "name": "Nome",
    "email": "[email protected]",
    "job_title": "job title value",
    "state": "state of the contact",
    "city": "city of the contact",
    "country": "country of the contact",
    "personal_phone": "phone of the contact",
    "mobile_phone": "mobile_phone of the contact",
    "twitter": "twitter handler of the contact",
    "facebook": "facebook name of the contact",
    "linkedin": "linkedin user name of the contact",
    "website": "website of the contact",
    "cf_custom_field_api_identifier": "custom field value",
    "company_name": "company name",
    "company_site": "company website",
    "company_address": "company address",
    "client_tracking_id": "lead tracking client_id",
    "traffic_source": "Google",
    "traffic_medium": "cpc",
    "traffic_campaign": "easter-50-off",
    "traffic_value": "easter eggs",
    "tags": ["mql", "2019"],
    "available_for_mailing": true,
    "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 Marcação de Oportunidade

O evento de Marcação de Oportunidade, registra a marcação de um contato como oportunidade no RD Station Marketing.

Request body parameters
FieldTypeRequiredDescription
event_typeStringtrueThe event type that diferentiates the event. For the opportunity event it should be sent as "OPPORTUNITY".
event_familyStringtrueThe family of the event for processing purposes. It currently accepts only "CDP" as valid option.
funnel_nameStringtrueName of the funnel to which the Contact should be marked as opportunity.
emailStringtrueEmail of the contact.
Request body example
{
  "event_type": "OPPORTUNITY",
  "event_family":"CDP",
  "payload": {
    "email": "[email protected]",
    "funnel_name": "default"
  }
}

Obs: This event does not create a new contact and requires an existing contact to be processed.


Evento de Marcação de Oportunidade Ganha

O evento de Marcação de Oportunidade Ganha, registra um contato como oportunidade ganha no RD Station Marketing.

Request body parameters
FieldTypeRequiredDescription
event_typeStringtrueThe event type that diferentiates the event. For the opportunity won event it should be sent as "SALE".
event_familyStringtrueThe family of the event for processing purposes. It currently accepts only "CDP" as valid option.
funnel_nameStringtrueName of the funnel to which the Contact should be marked as won.
emailStringtrueEmail of the contact.
valueFloatfalseValue of the won opportunity.
Request body example
{
  "event_type": "SALE",
  "event_family":"CDP",
  "payload": {
    "email": "[email protected]",
    "funnel_name": "default",
    "value": 200.0
  }
}

Obs: This event does not create a new contact and requires an existing contact to be processed.


Evento de Marcação de Oportunidade Perdida

O evento de Marcação de Oportunidade Perdida, registra um contato como oportunidade perdida no RD Station Marketing.

Request body parameters
FieldTypeRequiredDescription
event_typeStringtrueThe event type that diferentiates the event. For the opportunity lost event it should be sent as "OPPORTUNITY_LOST".
event_familyStringtrueThe family of the event for processing purposes. It currently accepts only "CDP" as valid option.
emailStringtrueEmail of the contact.
funnel_nameStringtrueName of the funnel to which the Contact should be marked as lost.
reasonStringfalseReason for why the Contact was marked as lost.
Request body example
{
  "event_type": "OPPORTUNITY_LOST",
  "event_family":"CDP",
  "payload": {
    "email": "[email protected]",
    "funnel_name": "default",
    "reason":"Lost reason"
  }
}

Obs: This event does not create a new contact and requires an existing contact to be processed.