This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
If an automation's action is delayed, implement this method to retrieve the latest data in the trigger payload before the action fires.
For example, if an automation is triggered but its action is set to fire only 24 hours later, Wix calls Refresh Payload before starting the action. This fetches the latest data in the trigger payload. The returned data can be used to update the trigger payload that is passed to the action.
Trigger key as defined in your app's trigger configuration in the app dashboard. For example, form_submitted
or invoice_due
.
ID of the related resource in GUID format.
Payload to update.
Updated payload.
Whether the automation activation should be canceled.
Default: false
.
A Refresh payload sample request for an event that had it's start date updated since the time the payload was sent
curl -X POST \
'https://www.<your-deployment-uri>.com/refresh-payload' \
-H 'user-agent: Wix' \
-H 'accept-encoding: gzip, deflate' \
-H 'content-type: text/plain; charset=utf-8' \
-d '{
"triggerKey": "event-starts",
"payload": {
"event_id": "13453-w33e",
"title": "My Party",
"start_date": "2026-01-07T07:45:00"
}
}'
{
"payload": {
"event_id": "13453-w33e",
"title": "My Party",
"start_date": "2026-02-10T10:00:00"
}
}