Skip to content

Retrigger events

Last updated: April 29, 2022

Learn how to rerun past events so you can retrigger the actions of your workflows – useful if you want to test a workflow that previously failed.


Reflow by multiple IDs

Use the following endpoint to retrigger past events associated with multiple event IDs and workflow IDs, or multiple subject IDs (for example, payment IDs and dispute IDs) and workflow IDs.

Your can find the full specification in our API reference.

Endpoints

For the full API specification, see the API reference.

post

https://api.checkout.com/workflows/events/reflow

Body parameters

Field nameDescription

events

required

array

A list of IDs for the events you want reflowed.

workflows

optional

array

A list of IDs for the workflows whose actions you want to trigger.

Request examples

1
{
2
"events": [
3
"evt_lzmo6p0i3612judj754w1ngtil",
4
"evt_05z6xuagtti48ajyfbuekg6a0a"
5
],
6
"workflows": [
7
"wf_sq8jnqi9i749hhb470bu308uk2",
8
"wf_bz91q7i4ks4sr0kasmas2xhp56"
9
]
10
}

Response

If successful, you'll receive a 202 success response.


Reflow by event ID

Pass an event's ID in the path of the following endpoint to rerun a single past event. This will trigger the actions of any existing workflows that are conditional on that event.

Your can find the full specification in our API reference.

Endpoints

For the full API specification, see the API reference.

post

https://api.checkout.com/workflows/events/{eventId}/reflow

The response

If successful, you'll receive a 202 success response.


Reflow by event and workflow ID

Pass an event ID and a workflow ID in the path of the following endpoint to retrigger all the actions associated with that specific event and workflow combination.

Your can find the full specification in our API reference.

Endpoints

For the full API specification, see the API reference.

post

https://api.checkout.com/workflows/events/{eventId}/workflow/{workflowId}/reflow

The response

If successful, you'll receive a 202 success response.


Reflow by subject ID

Pass a subject ID (for example, a payment ID or a dispute ID) in the path of the following endpoint to rerun any events associated with it and retrigger the actions of any associated workflows.

Your can find the full specification in our API reference.

Endpoints

For the full API specification, see the API reference.

post

https://api.checkout.com/workflows/events/subject/{subjectId}/reflow

The response

If successful, you'll receive a 202 success response.


Reflow by subject and workflow ID

Pass a subject ID (for example, a payment ID or a dispute ID) and a workflow ID in the path of the following endpoint to retrigger all the actions associated with that specific subject and workflow combination.

Your can find the full specification in our API reference).

Endpoints

For the full API specification, see the API reference.

post

https://api.checkout.com/workflows/events/subject/{subjectId}/workflow/{workflowId}/reflow

The response

If successful, you'll receive a 202 success response.