> For the complete documentation index, see [llms.txt](https://userguide.zappost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://userguide.zappost.com/zap-integrations/third-party-integrations/patchworks/installation-guide.md).

# Installation Guide

### Install the ZAP-POST Connector via the Patchworks Marketplace

1. Log in to Patchworks
2. From the home page, click on **Marketplace**
3. Search for ZAP-POST and click **Install**
4. Log into ZAP-POST at [zappost.com](https://app.zappost.com)
5. From the dashboard, click on **settings**
6. Select **API consumers** and **Add New Consumer**

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FOdABIfZXppX1UEd6StoN%2FScreenshot%202024-10-30%20102122.png?alt=media&amp;token=56d7594d-1dfe-4187-8fd7-599702bdac60" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
Never share your API credentials with anyone you don't trust
{% endhint %}

7. In Patchworks, click on **Process Flows** then **Connectors & Instances**
8. Click **Add new instance**

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2F8VIx9kdTe0DjW6fgD91i%2FScreenshot%202024-10-30%20103253.png?alt=media&amp;token=6108e38c-0f49-4b22-8d7e-12fbc4e06a5f" alt=""><figcaption></figcaption></figure>

9. Give your instance a name, we suggest something like 'ZAP-POST Production'
10. Click **Next Step**
11. Basic Authentication should already be selected, click **Next Step**
12. Here you need to enter your **API Key** and **API Password** from step 6
13. You're all set, your Patchwork and ZAP-POST accounts are integrated. To start ingesting customer data, see our [Use case how-to guide](broken://pages/Rk84s7wJaTSFtsQoXGE8)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://userguide.zappost.com/zap-integrations/third-party-integrations/patchworks/installation-guide.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
