Envoyer un événement avec l'API Omnisend

Envoie un événement client, en créant ou mettant à jour le contact, et lance les automatisations de la marque qui écoutent le nom de l'événement. Les événements personnalisés acceptent n'importe quel nom et propriétés ; les événements recommandés, comme placed order, suivent le schema de leur page dans la documentation Omnisend.

Identifiant
omnisend_send_event

L'appel

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

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
eventNamestringOuiName of the event, for example webinar registered, or the name of a recommended event such as placed order.
originstringOuiSource of the event: api for a custom store, or the name of the app that sends it.
contactobjectOuiWho the event belongs to, found by email, phone or id. The other fields update the contact.
propertiesobjectNonProperties of the event, keyed by name. Automations and segments can use them.
eventVersionstringNonOnly for recommended events: the version given on the page of the event in the Omnisend docs. Leave it out for custom events.
eventTimestringNonWhen the event happened, as RFC 3339. The default is now.
eventIDstringNonYour own UUID for the event. With eventTime, it avoids processing the same past event twice.

Connexions possibles

Votre client connecte son compte Omnisend une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/omnisend_send_event. Il devient la définition de tool de votre agent sans conversion.

Autres tools Omnisend

Voir les 14 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.