# Quickstart guide

## Introduction

All steps required to initialise a process flow via the [Patchworks Core API](broken://pages/EVn1AesQJtjyoIw7p0HZ) are detailed [below](/product-documentation/developer-hub/patchworks-core-api/core-api-spotlights/initialising-a-process-flow-and-sending-data-via-the-patchworks-api/the-steps.md). This page provides a quick overview of these steps.

## Summary

{% embed url="<https://youtu.be/iQhw4UnP5M4>" %}

<details>

<summary><img src="/files/lEJVjx8Wl8aiVinNFHeA" alt="" data-size="line"> Prepare your data</summary>

If you're passing in a payload via the request body, it must be stringified within a JSON object. For example:

```json
{
  "payload": "{\"a-stringified-json-payload\"}"
}
```

[Go to detailed steps ➜](/product-documentation/developer-hub/patchworks-core-api/core-api-spotlights/initialising-a-process-flow-and-sending-data-via-the-patchworks-api/the-steps/untitled.md)

</details>

<details>

<summary><img src="/files/ZwrogWXqyYBC1NviEd7W" alt="" data-size="line"> Map your data</summary>

If you're passing in a payload via the request body for syncing to a target connection, your process flow will need a map shape - source data fields (for your incoming payload) should be added manually.

[Go to detailed steps ➜](/product-documentation/developer-hub/patchworks-core-api/core-api-spotlights/initialising-a-process-flow-and-sending-data-via-the-patchworks-api/the-steps/mapping-payload-data.md)

</details>

<details>

<summary><img src="/files/OSjC4DiAICgGHd7vjtps" alt="" data-size="line"> Get flow IDs</summary>

The initialise flow API request requires two identifiers - one for for the flow to be run and another for the specific flow version.&#x20;

To find the process flow id, access the required process flow from the dashboard. You'll find the `process flow id` above the title at the top of the canvas:

<img src="/files/HCAmLFe7rYWZ9FOkMCC3" alt="" data-size="original">

And you'll find all process flow version ids at the bottom of process flow settings:

<img src="/files/1RXUeOG5hFJH55yZIxIF" alt="" data-size="original">

[Go to detailed steps ➜](/product-documentation/developer-hub/patchworks-core-api/core-api-spotlights/initialising-a-process-flow-and-sending-data-via-the-patchworks-api/the-steps/obtaining-process-flow-and-version-ids-for-api-requests.md)

</details>

<details>

<summary><img src="/files/c83han8bx81qgc2tfFR9" alt="" data-size="line"> Authenticate</summary>

To obtain a Patchworks token for API authentication, send a POST request to the following URL:&#x20;

```json
https://svc-fabric.pwks.co/api/v1/login
```

This request must include your Patchworks login credentials in the body:&#x20;

```json
{
    "email": "joe.bloggs@wearepatchworks.com",
    "password": "mypassword123*"
}
```

[Go to detailed steps ➜](/product-documentation/developer-hub/patchworks-core-api/core-api-spotlights/initialising-a-process-flow-and-sending-data-via-the-patchworks-api/the-steps/obtaining-a-token-for-patchworks-api-authentication.md)

</details>

<details>

<summary><img src="/files/wPSD9ZWEFthYgJiC2MJ1" alt="" data-size="line"> Initialise flow</summary>

To initialise a process flow, send a POST request to the following URL:&#x20;

```json
https://start.wearepatchworks.com/api/v1/flows/<flowID>/start/<flowVERSION>
```

Replacing `<flowID>` and `<flowVERSION>` with details for your required process flow noted previously, and authenticate with your Patchworks token.

[Go to detailed steps ➜](/product-documentation/developer-hub/patchworks-core-api/core-api-spotlights/initialising-a-process-flow-and-sending-data-via-the-patchworks-api/the-steps/initialising-a-process-flow-and-sending-data.md)

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/developer-hub/patchworks-core-api/core-api-spotlights/initialising-a-process-flow-and-sending-data-via-the-patchworks-api/quickstart-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.