Skip to main content
WEBHOOK

Authorizations

​
Authorization
string
header
required

Usa tu API Key como Bearer token en el header Authorization.

Ejemplo: Authorization: Bearer YOUR_API_KEY

Obtén tu API Key en la página de Settings.

Body

application/json
​
type
string

Tipo de evento (siempre "Email marketing" para este grupo)

Example:

"Email marketing"

​
event
string

Evento generado (siempre "open" para este webhook)

Example:

"open"

​
campid
string

ID único de la campaña

Example:

"12345"

​
relid
string

ID interno del cliente

Example:

"123"

​
cityName
string

Ciudad donde ocurrió el evento de apertura (la ubicación puede no ser precisa ya que algunos clientes de email cargan imágenes a través de proxies)

Example:

"Cali"

​
regionName
string

Región/Estado/Departamento donde ocurrió el evento

Example:

"Valle del cauca"

​
countryName
string

País donde ocurrió el evento

Example:

"Colombia"

​
latitude
number

Latitud donde ocurrió el evento

Example:

37.405991

​
longitude
number

Longitud donde ocurrió el evento

Example:

-122.078514

​
device_type
string

Tipo de dispositivo (puede no ser preciso)

Example:

"unknown"

​
browser
string

Navegador (puede no ser preciso)

Example:

"unknown"

​
timestamp
string

Fecha y hora del evento de apertura, zona horaria colombiana (GMT -5)

Example:

"2020-10-02 14:31:29"

​
email
string

Dirección del destinatario (mensajes reenviados, spam scanners u otras condiciones pueden disparar este evento)

Example:

"test@testdomain.com"

​
campaignName
string

Nombre interno de la campaña

Example:

"Test campaign name"

​
subject
string

Asunto de la campaña

Example:

"Test campaign subject"

​
contactId
string

ID interno del contacto

Example:

"112528991"

Response

200

Webhook recibido correctamente