# Inbound API for services

## Introduction  <a href="#introduction" id="introduction"></a>

With Patchworks standard integrations, you define a service with one system (a **connector**) configured as the **source** and another as the **destination**. Patchworks suggests **field mappings** between the two, but these can be tweaked as required.

Using an **Inbound API Connector**, you can configure a **custom entity** to define what information Patchworks should expect to receive in a payload from your bespoke system. Once configured, you specify this connector as the **source** in a Patchworks **service**, with another standard connector defined as the **destination**.&#x20;

As part of this, you define your preferred URL for API access. This means that you can create a managed set of API endpoints for your services, without reinventing the wheel - all completely code-free with error-handling, and guaranteed delivery.&#x20;

## Where to start? <a href="#where-to-start" id="where-to-start"></a>

The steps are:

1. ​[Add an Inbound API connector with a custom payload](/product-documentation/patchworks-services/inbound-api/using-the-inbound-api-connector-with-patchworks-services/adding-an-inbound-api-connector-with-a-custom-payload.md)
2. [​Obtain API authentication details](/product-documentation/patchworks-services/inbound-api/using-the-inbound-api-connector-with-patchworks-services/generating-token-credentials-for-api-access.md)
3. ​[Add a Patchworks service with your preferred URL](/product-documentation/patchworks-services/inbound-api/using-the-inbound-api-connector-with-patchworks-services/adding-a-patchworks-service-for-an-inbound-api-connector.md)
4. ​[Complete your API implementation with calls to this URL](/product-documentation/patchworks-services/inbound-api/using-the-inbound-api-connector-with-patchworks-services/implementing-api-requests.md)


---

# 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/patchworks-services/inbound-api/inbound-api-for-services.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.