Manage webhooks using the API
Last updated: December 3, 2025
After you've configured your webhook server and added a webhook workflow using the API, you can use the Workflows API to manage a workflow, or a workflow's conditions and actions.
Use the Workflows API to:
- Update a workflow you previously created.
- Get a workflow to view its details.
- Get all workflows you've created for your account.
- Remove a workflow.
- Test a workflow.
Note
When you delete a workflow, the actions of already executed workflows are still processed.
A workflow's conditions specify the criteria under which the workflow is triggered. For example, the events that trigger the workflow, and the entities and processing channels it applies to.
To manage a workflow's conditions, use the following endpoints and provide the workflowId and workflowConditionId path parameters:
A workflow's actions specify the action to take if the conditions are met. For example, sending a webhook.
To manage a workflow's actions, use the following endpoints and provide the workflowId and workflowActionId path parameters:
You can retrieve details about different event types using the following endpoints:
- Get event types to retrieve all types programmatically.
- Get subject events to retrieve all events for a specific subject. For example, a payment.
- Get action invocations to retrieve the details of an action applied for a specific event.
- Get an event to view its details.
Information
To retry a failed webhook, see Resend webhooks.
You can test a workflow by sending test events to your specified webhook URL. If the workflow is valid, Checkout.com sends the event types you selected with an isTest flag.
Information
The test event contains example data where possible, but the values may not be specific to the event type.
Call the Test a workflow endpoint, and provide the workflow ID as the {workflowId} path parameter.
post
https://api.sandbox.checkout.com/workflows/{workflowId}/test
You receive a 202 response if the test workflow was initiated successfully.