Skip to main content
POST
/
integrators
/
timeline
/
v3
/
events
Send event data (single)
curl --request POST \
  --url https://api.hubapi.com/integrators/timeline/v3/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "eventTemplateId": "1001298",
  "email": "art3mis-pup@petspot.com",
  "tokens": {
    "petName": "Art3mis",
    "petAge": 3,
    "petColor": "black"
  },
  "extraData": {
    "questions": [
      {
        "question": "Who'\''s a good girl?",
        "answer": "Bark!"
      },
      {
        "question": "Do you wanna go on a walk?",
        "answer": "Woof!"
      }
    ]
  },
  "timelineIFrame": {
    "linkLabel": "View Art3mis",
    "headerLabel": "Art3mis dog",
    "url": "https://my.petspot.com/pets/Art3mis",
    "width": 600,
    "height": 400
  }
}'
{
  "objectType": "contacts",
  "id": "petspot:1001298:art3mis-pup@petspot.com-004",
  "eventTemplateId": "1001298",
  "email": "art3mis-pup@petspot.com",
  "objectId": "28001",
  "timestamp": "2020-01-30T17:42:10.276Z",
  "tokens": {
    "petName": "Art3mis",
    "petColor": "black",
    "petAge": "3"
  },
  "extraData": {
    "questions": [
      {
        "question": "Who's a good girl?",
        "answer": "Bark!"
      },
      {
        "question": "Do you wanna go on a walk?",
        "answer": "Woof!"
      }
    ]
  },
  "timelineIFrame": {
    "linkLabel": "View Art3mis",
    "headerLabel": "Art3mis dog",
    "url": "https://my.petspot.com/pets/Art3mis",
    "width": 600,
    "height": 400
  }
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubGratuito
Sales HubSales HubGratuito
Service HubService HubGratuito
Content HubContent HubStarter

​
Ámbitos Requeridos

Esta API requiere uno de los siguientes ámbitos:
  • crm.schemas.contacts.write
  • crm.objects.deals.sensitive.write.v2
  • tickets
  • crm.objects.companies.highly_sensitive.write.v2
  • crm.objects.deals.highly_sensitive.write.v2
  • tickets.sensitive.v2
  • crm.objects.deals.write
  • crm.objects.companies.write
  • tickets.highly_sensitive.v2
  • crm.schemas.deals.write
  • crm.objects.companies.sensitive.write.v2
  • crm.objects.contacts.write
  • crm.schemas.companies.write
  • crm.objects.contacts.highly_sensitive.write.v2
  • crm.objects.contacts.sensitive.write.v2
  • timeline

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

The timeline event definition.

The state of the timeline event.

​
eventTemplateId
string
required

El ID de la plantilla de evento.

Example:

"1001298"

​
tokens
object
required

Una colección de claves de token y los valores asociados con los tokens de plantilla.

Example:

"{\"petAge\":3,\"petName\":\"Art3mis\",\"petColor\":\"black\"}"

​
extraData
object

Datos adicionales específicos del evento que pueden ser interpretados por el markdown de la plantilla.

Example:

"{\"questions\":[{\"answer\":\"Bark!\",\"question\":\"Who's a good girl?\"},{\"answer\":\"Woof!\",\"question\":\"Do you wanna go on a walk?\"}]}"

​
timelineIFrame
object
Example:
{
  "linkLabel": "View Art3mis",
  "headerLabel": "Art3mis dog",
  "url": "https://my.petspot.com/pets/Art3mis",
  "width": 600,
  "height": 400
}
​
domain
string

El dominio del evento (con frecuencia combinado con utk).

​
id
string

Identificador del evento. Esto es opcional, y recomendamos que no lo incluyas. Crearemos uno por ti si lo omites. También puedes usar "{{uuid}}" en cualquier parte del ID para generar una cadena única, garantizando la unicidad.

​
utk
string

Usa el parámetro "utk" para asociar un evento con un contacto por "usertoken". Esto se recomienda si no conoces el correo de un usuario, pero tienes un token que identifica al usuario en tu cookie.

​
email
string

La dirección de correo utilizada para eventos específicos del contacto. Se puede usar para identificar contactos existentes, crear nuevos contactos o cambiar el correo de un contacto existente (si se combina con "objectId").

Example:

"art3mis-pup@petspot.com"

​
objectId
string

El identificador del objeto del CRM. Es obligatorio para todos los eventos excepto para los contactos (donde se puede usar utk o correo).

​
timestamp
string<date-time>

La hora cuando ocurrió el evento. Si no se incluye, se usará la hora actual. Esto se utiliza para determinar dónde se muestra un evento en la cronología de un objeto del CRM.

Response

successful operation

The current state of the timeline event.

​
eventTemplateId
string
required

El ID de la plantilla de evento.

Example:

"1001298"

​
tokens
object
required

Una colección de claves de token y los valores asociados con los tokens de plantilla.

Example:

"{\"petAge\":\"3\",\"petName\":\"Art3mis\",\"petColor\":\"black\"}"

​
id
string
required

Identificador del evento. Debe ser único para la aplicación y la plantilla del evento. Si utilizas el mismo ID para diferentes objetos del CRM, el último en ser procesado ganará y el primero no tendrá un registro. También puedes usar "{{uuid}}" en cualquier parte del ID para generar una cadena única, garantizando la unicidad.

Example:

"petspot:1001298:art3mis-pup@petspot.com-004-invalid"

​
objectType
string
required

El ObjectType asociado con el EventTemplate.

Example:

"contacts"

​
createdAt
string<date-time>
​
extraData
object

Datos adicionales específicos del evento que pueden ser interpretados por el markdown de la plantilla.

Example:

"{\"questions\":[{\"answer\":\"Bark!\",\"question\":\"Who's a good girl?\"},{\"answer\":\"Woof!\",\"question\":\"Do you wanna go on a walk?\"}]}"

​
timelineIFrame
object
Example:
{
  "linkLabel": "View Art3mis",
  "headerLabel": "Art3mis dog",
  "url": "https://my.petspot.com/pets/Art3mis",
  "width": 600,
  "height": 400
}
​
domain
string

El dominio del evento (con frecuencia asociado con utk).

​
utk
string

Usa el parámetro "utk" para asociar un evento con un contacto por "usertoken". Esto se recomienda si no conoces el correo de un usuario, pero tienes un token que identifica al usuario en tu cookie.

​
email
string

La dirección de correo utilizada para eventos específicos del contacto. Se puede usar para identificar contactos existentes, crear nuevos contactos o cambiar el correo de un contacto existente (si se combina con "objectId").

Example:

"art3mis-pup@petspot.com"

​
objectId
string

El identificador del objeto de CRM. Es obligatorio para todos los eventos excepto para los contactos (donde se puede usar utk o correo).

Example:

"28001"

​
timestamp
string<date-time>

La hora cuando ocurrió el evento. Si no se incluye, se usará la hora actual. Esto se utiliza para determinar dónde se muestra un evento en la cronología de un objeto del CRM.

Example:

"2020-01-30T18:37:15.569+00:00"

⌘I