Send event with the Omnisend API

Sends a customer event, creating or updating the contact, and starts the automations of the brand that listen to the event name. Custom events take any name and properties; recommended events, such as placed order, follow the schema of their page in the Omnisend docs.

Identifier
omnisend_send_event

The request

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

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
eventNamestringYesName of the event, for example webinar registered, or the name of a recommended event such as placed order.
originstringYesSource of the event: api for a custom store, or the name of the app that sends it.
contactobjectYesWho 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.

Supported connections

Your customer connects their Omnisend account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/omnisend_send_event. It becomes your agent's tool definition with no conversion.

Other Omnisend tools

See all 14 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.