Enriquecimiento de Datos


Esta guía te mostrará cómo hacer tu primera llamada a la API de RD Station.

Aprende cómo integrar tu aplicación para enriquecimiento de datos mediante las API de RD Station.

Por definición, una aplicación de enriquecimiento de datos del contacto debe poder devolver una información que será útil en la calificación del contacto usando como base algun otro dato, o para disparar flujos de automatización.

Otro caso de uso que es posible es cuando la aplicación externa permanece "enriqueciendo" los datos del Contacto en segundo plano y, cuando se descubre o actualiza una nueva información, actualiza la información del Contacto en RD Station.

El proceso principal se resume en este gráfico:

Enrichment es

Vamos mostrarte cómo recuperar un solo contacto usando el UUID Rest API Endpoint. Para ello, te acompañaremos a través del proceso de autenticación para generar un token de acceso, que será usado para realizar una HTTP GET request. A continuación, te proporcionaremos el código para realizar la solicitud que devuelve la información de Contacto formateada en formato JSON.


Cómo generar un token de autenticación

  1. Crea una cuenta de prueba en este link.
  2. El token de autenticación se debe obtener siguiendo los pasos que se describen en Autorización.


Cómo utilizar webhooks como triggers de tu aplicación

Después de entrar en tu cuenta de RD Station, sigue estos pasos: tu cuenta-> integraciones-> webhooks. Haz clic en el botón crear webhook. Define:

  1. Un nombre para tu integración. La idea aquí es crear un nombre que te ayude a identificar a qué herramienta se está enviando esta información.

  2. La URL de la herramienta recibirá la notificación de RDStation con la información del Contacto.

  3. El trigger que debe activar el envío de la notificación


En este caso puedes solicitar que se envíe la notificación:

Nueva conversión: Enviar a la herramienta contactos que realizan alguna conversión en RD Station. Tu puedes seleccionar lo que estas conversiones serán o dejarlas en blanco, en ese caso cada contacto que realiza una conversión será enviado.

o

Oportunidad: Envía los contactos marcados como oportunidad (starlet). Ejemplo: Envíe el contacto de RD Station a la herramienta sólo cuando esté marcado como una oportunidad manualmente o a través de un flujo de automatización.


Cómo utilizar webhooks como trigger de tu aplicación

El flujo de automatización te permitirá enviar el contacto de acuerdo a las condiciones definidas del propio flujo, mientras que a través de la integración normal, sólo puedes optar por enviar el lead con cada conversión o cuando se marca como una oportunidad.

Todo lo que necesitas es introducir en el flujo de automatización la dirección URL a la que deseas que se envíe la información de Contacto, utilizando la acción Enviar Lead a la URL.

Esta URL es de tu sistema, la cual recibirá la solicitud de RD Station con la notificación del Contacto. La solicitud de la URL se realiza mediante una solicitud POST-type Http.

La información se enviará como JSON. Un ejemplo de JSON es en este link.


Cómo crear un WebService para recibir un contacto de RD Station

La creación del servicio Web que recibirá los contactos de RD Station debe tener los siguientes requisitos:

  • Ser capaz de recibir un JSON en el formato de RD Station;
  • Ser capaz de recibir un parámetro específico para identificar qué cliente está enviando la solicitud (podría ser un dominio específico para cada cliente también). La URL completa con parámetros debe ser fácil para recuperar y utilizar en los flujos de RD Station/automatización;
  • Almacene el Contacto UUID (campo UUID en el JSON, que es la clave principal de la API de datos) y el correo electrónico principal (utilizado como clave para otras aplicaciones en RD).

Cómo usar la API para recuperar informaciones de contacto (GET)


Returns data about a specific Contact
Request Parameter
Field Type Description
uuid Type: String The unique uuid associated to each RD Station Contact.

Response Body Parameters
Field Type Description
uuid String The unique uuid associated to each RD Station Contact.
name String Name of the Contact.
email String Email of the Contact.
bio String Notes about the Contact.
website String Website of the Contact.
job_title String Job title of the Contact.
personal_phone String Phone of the Contact.
mobile_phone String Mobile phone of the Contact.
city String City of the Contact.
state String State of the Contact.
country String Country of the Contact.
twitter String Twitter of the Contact.
facebook String Facebook of the Contact.
linkedin String Linkedin of the Contact.
tags ArrayStrings Tags of the Contact.
extra_emails ArrayStrings Extra emails of the Contact.
legal_bases ArrayObjects Legal Bases of the Contact.

Empty Fields

For empty value fields the following behavior will be adopted:

Type Description
String and Numbers attributes will not be returned
Array an empty array will be returned []
Boolean Always true or false will be returned
Example:
  {
  "name": "RD Station Developer",
  "email": "contact@example.com",
  "job_title": "Developer",
  "bio": "This documentation explains the RD Station API.",
  "website": "https://developers.rdstation.com/",
  "linkedin": "rd_station",
  "personal_phone": "+55 48 3037-3600",
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "tags": ["developer", "rdstation", "api"],
  "extra_emails": ["contact2@example.com"],
  "cf_custom_field_2": "custom field value2",
  "legal_bases": [
    {
      "category": "data_processing",
      "type": "pre_existent_contract",
      "status": "granted"
    },
    {
      "category": "communications",
      "type": "consent",
      "status": "granted"
    }
  ]
}

Cómo utilizar la API para actualizar informaciones de contacto (PATCH)


Updates the properties of a Contact.
Request Parameter
Field Type Description
uuid String The unique uuid associated to each RD Station Contact.

Request Body Default Parameters
Field Type Description
email String Email of the Contact
name String Name of the Contact
bio String Notes about the Contact.
job_title String Job title of the Contact
linkedin String Linkedin profile of the Contact
facebook String Facebook profile of the Contact
city String City of the Contact.
state String State of the Contact.
country String Country of the Contact.
twitter String Twitter profile of the Contact
personal_phone String Personal phone of the Contact
mobile_phone String Mobile phone number of the Contact
website String Website of the Contact
tags ArrayStrings Tags of the Contact
legal_bases ArrayObjects Legal Bases of the Contact.

Request Body Custom Field Parameters
When updating the custom fields information, the attribute keys should be sent as the API name of the custom field. The custom field value should also be adequated accordingly to the field's type.

Field Type Description
cf_text_field String Custom field of type text.
cf_text_area String Custom field of type text area.
cf_multiple_choice ArrayStrings Custom field of type multiple choice.
cf_radio_button String Custom field of type radio button.
cf_number Integer Custom field of type number.
cf_url String Custom field of type URL.
cf_telephone String Custom field of type telephone.
cf_email String Custom field of type email.
cf_checkbox Boolean Custom field of type checkbox.
cf_combobox String Custom field of type combobox.

Response Body Parameters
Field Type Description
uuid String The unique uuid associated to each RD Station Contact.
name String Name of the Contact.
email String Email of the Contact.
bio String Notes about the Contact.
website String Website of the Contact.
job_title String Job title of the Contact.
personal_phone String Phone of the Contact.
mobile_phone String Mobile phone of the Contact.
city String City of the Contact.
state String State of the Contact.
country String Country of the Contact.
twitter String Twitter of the Contact.
facebook String Facebook of the Contact.
linkedin String Linkedin of the Contact.
tags ArrayStrings Tags of the Contact.
extra_emails ArrayStrings Extra emails of the Contact.
legal_bases ArrayObjects Legal Bases of the Contact.

Empty Fields

For empty value fields the following behavior will be adopted:

Type Description
String and Numbers attributes will not be returned
Array an empty array will be returned []
Boolean Always true or false will be returned
Example:
  {
  "name": "RD Station Developer",
  "email": "contact@example.com",
  "job_title": "Developer",
  "bio": "This documentation explains the RD Station API.",
  "website": "https://developers.rdstation.com/",
  "linkedin": "rd_station",
  "personal_phone": "+55 48 3037-3600",
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "tags": ["developer", "rdstation", "api"],
  "extra_emails": ["contact2@example.com"],
  "cf_custom_field_2": "custom field value2",
  "legal_bases": [
    {
      "category": "data_processing",
      "type": "pre_existent_contract"
    },
    {
      "category": "communications",
      "type": "consent",
      "status": "granted"
    }
  ]
}

Legal Bases
Field Type Valid params
category String data_processing or communications
type String pre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
status String granted or declined (only when category is communications)

Obs: When the category is data_processing the field status is not mandatory, but pay attention to the fact that if you include this field, the only accepted value for status is granted.


Cómo utilizar la API de campos personalizados para comprobar y crear campos necesarios

Para poder actualizar la información del Contacto, es necesario que los campos que se están actualizando estén correctamente creados en RD Station. Si no existen, la información no puede ser utilizada con fines específicos (ej: segmentaciones, flujos de automatización o Lead Scoring).

Idealmente, en el momento de implementación de la integración, el sistema externo debe comprobar la existencia de los campos necesarios para el enriquecimiento de datos en los casos de uso conocidos. Si no se encuentran, el sistema debe crear estos campos sin necesidad de configuración manual. Estos detalles pueden ser verificados en la sección Campos personalizados.