Enviar evento no Omnisend, por uma API

Envia um evento de cliente, criando ou atualizando o contato, e inicia as automações da marca que escutam o nome do evento. Eventos customizados aceitam qualquer nome e propriedades; eventos recomendados, como placed order, seguem o schema da sua página na documentação do Omnisend.

Identificador
omnisend_send_event

A chamada

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": {}
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
eventNamestringSimName of the event, for example webinar registered, or the name of a recommended event such as placed order.
originstringSimSource of the event: api for a custom store, or the name of the app that sends it.
contactobjectSimWho the event belongs to, found by email, phone or id. The other fields update the contact.
propertiesobjectNãoProperties of the event, keyed by name. Automations and segments can use them.
eventVersionstringNãoOnly for recommended events: the version given on the page of the event in the Omnisend docs. Leave it out for custom events.
eventTimestringNãoWhen the event happened, as RFC 3339. The default is now.
eventIDstringNãoYour own UUID for the event. With eventTime, it avoids processing the same past event twice.

Conexões possíveis

O seu cliente conecta a conta do Omnisend uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/omnisend_send_event. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Omnisend

Ver as 14 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.