Reports an event and activates site automations with the specified trigger key.
Only the app that created a trigger can report events for it. This means other apps can't report events for your triggers, and you can't report events for another app's triggers.
If your app supports canceling events,
externalEntityId
must be provided.
externalEntityId
is required when calling Cancel Event.
You cannot try out this endpoint because
it can be called only by the app that created the specified triggerKey
.
So please ignore the Try It Out button.
You can only call this method when authenticated as a Wix app or Wix user identity.
Trigger key as defined in your app's trigger configuration
in the app dashboard.
For example, form_submitted
or invoice_due
.
Event payload, formatted as key:value pairs. Must comply with the payload schema if you provided one when configuring your trigger.
Key names can include only alphanumeric characters or underscores
(A-Z
, a-z
, 0-9
, _
).
They cannot start with an underscore.
Values can be strings, numbers, integers, booleans, or arrays. If a value is an array, the array items must be objects, and nested object properties must be strings, numbers, integers, or booleans only.
ID of the related resource in GUID format.
For example, fc81a355-3429-50fc-a4c7-def486e828f3
.
Required if your app needs to cancel the event if the automation becomes no longer relevant.
Typically, this ID is defined in your system,
but you can also use any Wix resource GUID,
such as contact ID, member ID, or invoice ID.
See
Choose the right externalEntityId
for more information.
Idempotency information for the event.
The activation IDs of triggered ReportEvents.
curl POST https://www.wixapis.com/automations/v1/events/report \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>' \
-d '{
"triggerKey": "my_trigger",
"payload": {
"name": "John Doe"
},
"externalEntityId": "16ef8c9c-413e-4d5f-b77d-8c67c3c8ae0c"
}'
{}
There is 1 error with this status code.
There is 1 error with this status code.
This method may also return standard errors. Learn more about standard Wix errors.