# Workflow

Source: https://docs.pitchpointsolutions.com/api/workflow/index/

**Beta**

## Workflow API

A workflow is one run of a product against your data. Start one and you get a `workflowId` back straight away, while the product runs in the background. Read the workflow to follow its state, or trigger a reconfirm to run it again under the same handle. Once the application behind a workflow reaches an outcome, an approved integration system can report it. A product set up for outcome-based billing uses the reported outcomes to bill only for the results your agreement covers, such as loans that fund.

You can start a workflow with your data supplied inline, or against a session that already holds it.

> **API Reference:** [Sessions and Workflows](https://docs.pitchpointsolutions.com/developer_guides/sessions_and_workflows/index/) covers starting a workflow, learning when the result is ready, and reading it.

> **API Reference:** Browse every operation, its schemas and code samples in the [API Explorer](https://docs.pitchpointsolutions.com/api/explorer/?api=workflows), or download the [OpenAPI specification](https://docs.pitchpointsolutions.com/assets/openapi/workflows-v1.yaml) for your own tools.

Every path below is relative to the base URL:

```text
https://api.pointservices.com/riskinsight-services-ws/resources
```

| Operation | Method and path | Reference |
|---|---|---|
| Start a Workflow | `POST /v1/workflows` | [Start a Workflow](https://docs.pitchpointsolutions.com/api/workflow/start_workflow/) |
| Read a Workflow | `GET /v1/workflows/{workflowId}` | [Read a Workflow](https://docs.pitchpointsolutions.com/api/workflow/get_workflow/) |
| Reconfirm a Workflow | `POST /v1/workflows/{workflowId}` | [Reconfirm a Workflow](https://docs.pitchpointsolutions.com/api/workflow/reconfirm_workflow/) |
| Edit a Workflow | `POST /v1/workflows/{workflowId}/edit` | [Edit a Workflow](https://docs.pitchpointsolutions.com/api/workflow/edit_workflow/) |
| Find Workflows | `GET /v1/workflows` | [Find Workflows](https://docs.pitchpointsolutions.com/api/workflow/list_workflows/) |

A reconfirm keeps the same `workflowId` and issues a new `runId`. It is billed as its own workflow.

To learn when a result is ready without polling, register a webhook endpoint — see [Webhooks](https://docs.pitchpointsolutions.com/developer_guides/webhooks/index/).