Cancel Event
All events are created with an execution date, that schedule the event to be executed in that time. If you need to run the event manually you can use this endpoint to force the execution. Another example, that does not happen often, is the event wasn’t added in the schedule stack to be executed and you need to run it manually.
Information | Data | Description |
---|---|---|
URL | - | Provided by boltPay squad |
Endpoint | /execution-event/{eventSid}/cancel | eventSid: Generated sid for the step event. This could be find in the nextEvent attribute detail in the result of the get instance. |
Method | POST | - |
Body | - | - |
Request
POST {url}/execution-event/911414b4-3e0f-491a-ac00-8a3953c12fca/cancel
Headers: { Content-Type: application/json, Strategy-Secret: asdxcv123asdzxcv, Authorization: Bearer asd123asdfd123.asdasd123.asda13213 }
Response
{
"instanceSid": "1b791c08-6c95-4dba-8b26-2efafb1fa366",
"strategySid": "e95134ab-7cb8-4f0f-9862-038730c9f12f",
"status": "CANCELED",
"afterCancellation": false,
"date": "2021-08-26T16:20:20.304Z",
"attempt": 1,
"createdAt": "2021-08-26T16:07:01.403Z"
}