Workflows
Add a workflow action
Adds a workflow action. Actions determine what the workflow will do when it is triggered.
post/workflows/{workflowId}/actions
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": "webhook",
"url": "https://example.com/webhooks",
"headers": {
"Authorization": "<AUTHORIZATION_UUID>"
}
}Response
Workflow action added successfully
Example response
{
"id": "wfa_wlu3wxc26jounofs5iez75qaqa",
"_links": {
"self": {
"href": "https://{prefix}.api.checkout.com/workflows/wf_wlu3wxc26jounofs5iez75qaqa/actions/wfa_wlu3wxc26jounofs5iez75qaqa"
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.