# Workflows API

> Create and update workflows, manage workflow variables and inspect process errors.

Source: https://developer.kustomer.com/api/workflows

Server: `https://api.kustomerapp.com/v1` · 10 operations

This category describes endpoints related to Kustomer workflow.

Workflows are automations you can trigger when events occur in Kustomer or in a connected app or external platform. 

You can use workflows with conditional branching to add tags, assign users, create customers, or make calls to external systems.

To learn more, see [Workflows overview](https://help.kustomer.com/workflows-overview-HJFVTZhzz) in the Kustomer Help Center.

## Workflows

A workflow is an automation that runs inside Kustomer whenever an event happens. A trigger starts each run, and steps call actions, with conditions choosing the path from one step to the next.

- [Get workflows](https://developer.kustomer.com/api/workflows/get-workflows.md): `GET /v1/workflows`
- [Create a workflow](https://developer.kustomer.com/api/workflows/create-a-workflow.md): `POST /v1/workflows`
- [Get a workflow based on the ID](https://developer.kustomer.com/api/workflows/get-a-workflow-based-on-the-id.md): `GET /v1/workflows/{id}`
- [Update a workflow based on the ID](https://developer.kustomer.com/api/workflows/update-a-workflow-based-on-the-id.md): `PUT /v1/workflows/{id}`

## Workflow Variables

A workflow variable is a named value stored with one workflow, such as an API key or a URL that differs between sandbox and production. Steps can use it without the value being written into the workflow itself.

- [Get all variables for a workflow](https://developer.kustomer.com/api/workflows/get-all-variables-for-a-workflow.md): `GET /v1/workflows/{id}/variables`
- [Create a workflow variable for a workflow](https://developer.kustomer.com/api/workflows/create-a-workflow-variable-for-a-workflow.md): `POST /v1/workflows/{id}/variables`
- [Get a workflow variable](https://developer.kustomer.com/api/workflows/get-a-workflow-variable.md): `GET /v1/workflow-variables/{id}`
- [Update a workflow variable](https://developer.kustomer.com/api/workflows/update-a-workflow-variable.md): `PUT /v1/workflow-variables/{id}`
- [Delete a workflow variable](https://developer.kustomer.com/api/workflows/delete-a-workflow-variable.md): `DELETE /v1/workflow-variables/{id}`

## Workflow Processes (Errors)

A workflow process is the record Kustomer keeps when a workflow run fails. It stores the event that started the run, the error, and the run's context up to the failure, so you can see what went wrong.

- [Get processes (errors) by workflow](https://developer.kustomer.com/api/workflows/get-processes-errors-by-workflow.md): `GET /v1/workflows/{id}/processes`
