Guía práctica
Eventos de espacio de trabajo
Define eventos de espacio de trabajo y el tipo de cada propiedad para que todos los sistemas que los envían sean coherentes. Incluye los tipos de propiedad, la validación y cómo cambiar una definición.
Un evento de espacio de trabajo es un evento que tu espacio de trabajo declara antes de que nadie lo envíe: su nombre, un título opcional y las propiedades que lleva, cada una con un tipo. Los eventos de ese tipo se envían como w:<name>, y Emailit rechaza los que no coinciden. Esta página explica cómo definirlos y cómo funciona la validación.
Si no quieres declarar una estructura, envía en su lugar un evento personalizado (c:<name>). Los eventos de espacio de trabajo y los personalizados están incluidos en los planes Pro, Business y Custom.
Definir un evento de espacio de trabajo
-
Abre los eventos de espacio de trabajo. Ve a Email APIEvents, selecciona la pestaña Workspace events y después Define workspace event.
-
Ponle nombre al evento. Introduce un Name como
customer.type. Se envía comow:customer.type. Si quieres, añade un Title, que se muestra en las cronologías y en los selectores, y una Description para tu equipo. -
Añade propiedades. Selecciona Add property por cada valor que deban o puedan incluir quienes envían el evento. Ponle un nombre, elige su Type y activa Required si todos los eventos deben tenerlo. El título y la descripción son opcionales.
-
Créalo. Selecciona Create. Para probarlo, selecciona Send test en la definición: se abre Send event con el evento ya elegido.
Llama a Crear un evento de espacio de trabajo con una clave de API con Full Access:
curl -X POST https://api.emailit.com/v2/workspace/events \
-H "Authorization: Bearer $EMAILIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "customer.type",
"title": "Customer type",
"properties": [
{ "name": "segment", "type": "string", "required": true },
{ "name": "since", "type": "date" }
]
}'Después, envíalo como cualquier otro evento, con el script de seguimiento o con la API:
curl -X POST https://api.emailit.com/v2/events \
-H "Authorization: Bearer $EMAILIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "type": "w:customer.type", "email": "jane@example.com", "properties": { "segment": "b2b", "since": "2026-10-01" } }'Tipos de propiedades
| Tipo | Acepta | Se guarda como |
|---|---|---|
string |
Una cadena JSON, de hasta 2000 caracteres. | La cadena |
number |
Un número JSON. Los números entre comillas, como "42", se rechazan. |
El número |
date |
Una fecha ISO 8601 (2026-10-01), una fecha y hora (2026-10-01T12:00:00Z) o una marca de tiempo en milisegundos. Los años anteriores a 1900 se rechazan. |
Una fecha y hora ISO 8601 en UTC |
boolean |
true o false. |
El booleano |
Cómo se comprueban los eventos
Cuando llega un evento w:, Emailit compara sus properties con la definición:
- Todas las propiedades tienen que estar en la definición. Las propiedades desconocidas se rechazan, así que una errata no pasa desapercibida.
- Las propiedades obligatorias tienen que estar presentes y no ser
null. - Una propiedad opcional se puede omitir o enviar como
nullpara indicar que está vacía. - Cada valor tiene que coincidir con su tipo.
Un evento w: cuyo nombre no está definido también se rechaza. La API responde con 422 y cada problema identificado por su ruta, como properties.since. El script de seguimiento descarta los eventos no válidos y, con la depuración activada, muestra el motivo.
Cambiar o eliminar una definición
En la pestaña Workspace events, selecciona Edit o Delete en una definición. Con la API, usa Actualizar un evento de espacio de trabajo y Eliminar un evento de espacio de trabajo.
- Una definición solo comprueba los eventos nuevos. Los eventos ya guardados conservan las propiedades que tenían.
- Cambiar las propiedades sustituye la lista completa. Los sistemas que sigan enviando una propiedad eliminada reciben errores, así que actualízalos antes o a la vez.
- Cambiar el nombre cambia el tipo que hay que enviar. Los eventos guardados conservan el tipo antiguo, y los eventos nuevos con el nombre antiguo se rechazan.
- Al eliminar una definición, los eventos guardados se conservan, y los eventos nuevos de ese tipo se rechazan hasta que vuelvas a definirlo.
Límites
Un espacio de trabajo puede definir tantos eventos de espacio de trabajo como tipos de eventos tenga su plan: 100 en Pro y 1000 en Business, sin límite en Custom. Uno más devuelve 422 con code workspace_events_limit. Cada evento de espacio de trabajo tiene hasta 50 propiedades. Los nombres tienen hasta 100 caracteres; los nombres de propiedad, hasta 64; los títulos, hasta 120, y las descripciones, hasta 1000.