Enviar evento en Omnisend, con una API

Envía un evento de cliente, creando o actualizando el contacto, e inicia las automatizaciones de la marca que escuchan el nombre del evento. Los eventos personalizados aceptan cualquier nombre y propiedades; los eventos recomendados, como placed order, siguen el schema de su página en la documentación de Omnisend.

Identificador
omnisend_send_event

La llamada

POST https://connect.reportei.com/api/tools/omnisend_send_event/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "eventName": "<eventName>",
    "origin": "<origin>",
    "contact": {}
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
eventNamestringSíName of the event, for example webinar registered, or the name of a recommended event such as placed order.
originstringSíSource of the event: api for a custom store, or the name of the app that sends it.
contactobjectSíWho the event belongs to, found by email, phone or id. The other fields update the contact.
propertiesobjectNoProperties of the event, keyed by name. Automations and segments can use them.
eventVersionstringNoOnly for recommended events: the version given on the page of the event in the Omnisend docs. Leave it out for custom events.
eventTimestringNoWhen the event happened, as RFC 3339. The default is now.
eventIDstringNoYour own UUID for the event. With eventTime, it avoids processing the same past event twice.

Conexiones posibles

Tu cliente conecta su cuenta de Omnisend una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/omnisend_send_event. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Omnisend

Ver las 14 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.