Workflows
Add a workflow condition
Adds a workflow condition. Conditions determine when the workflow will trigger.
post/workflows/{workflowId}/conditions
Request
- Base URLhttps://{prefix}.api.sandbox.checkout.com
- Auth
- OAuth 2Client credentialsToken URLstringScopesflow, flow:workflows
- or API key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
workflowIdstring required
The workflow identifier
Request body
Example request
{
"type": "event",
"events": {
"gateway": [
"payment_approved",
"payment_pending",
"payment_declined"
]
}
}Response
Workflow condition added successfully
Example response
{
"id": "wfc_wlu3wxc26jounofs5iez75qaqa",
"_links": {
"self": {
"href": "https://{prefix}.api.checkout.com/workflows/wf_wlu3wxc26jounofs5iez75qaqa/conditions/wfc_wlu3wxc26jounofs5iez75qaqa"
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.