Workflow endpoints

Build and operate the end-to-end processing workflows that move documents from source to destination. Create, configure, and trigger runs, and manage workflow-scoped notification channels to stay informed on execution status.

Name	Method	Path
List workflows	GET	/api/v1/workflows/
Get workflow	GET	/api/v1/workflows/{workflow_id}
Create workflow	POST	/api/v1/workflows/
Update workflow	PUT	/api/v1/workflows/{workflow_id}
Delete workflow	DELETE	/api/v1/workflows/{workflow_id}
Run workflow	POST	/api/v1/workflows/{workflow_id}/run
List workflow notification channels	GET	/api/v1/workflows/{workflow_id}/notifications/channels
Get workflow notification channel	GET	/api/v1/workflows/{workflow_id}/notifications/channels/{channel_id}
Create workflow notification channel	POST	/api/v1/workflows/{workflow_id}/notifications/channels
Update workflow notification channel	PATCH	/api/v1/workflows/{workflow_id}/notifications/channels/{channel_id}
Delete workflow notification channel	DELETE	/api/v1/workflows/{workflow_id}/notifications/channels/{channel_id}
Verify workflow notification channel	POST	/api/v1/workflows/{workflow_id}/notifications/channels/{channel_id}/verify

To read and manage workspace-scoped notification channels, use the following endpoints:

• List workspace notification channels
• Get workspace notification channel
• Create workspace notification channel
• Update workspace notification channel
• Delete workspace notification channel
• Verify workspace notification channel

For more information about notification channels, see Webhooks and Email notifications.