# Whistl (prebuilt connector)

## Description

**Whistl** is the UK's leading logistics company, specialising in fulfilment, contact centres, mail and parcel delivery management.

## API documentation

API documentation for **Whistl** (used to build this connector) can be found via the link below:

{% embed url="<https://app.swaggerhub.com/apis-docs/whistl/whistl-api_for_wms_integration/2.0.11#/>" %}

## Authentication&#x20;

When adding connector instances for **Google Sheets**, the following authentication methods are supported:

* [OAuth 2 (client credentials)](#oauth-2-authorisation-code)
* [Token](#token-authentication)

### OAuth 2 (client credentials)

When a user chooses to [add a connector instance](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) using **OAuth 2 (client credentials)** authentication, the credentials below are prompted:

<table><thead><tr><th>Credential</th><th data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>Scope</code></td><td>true</td><td>Set to <code>public</code>.</td></tr><tr><td><code>Client ID</code></td><td>true</td><td>Your client id for the  Patchworks integration.</td></tr><tr><td><code>Client secret</code></td><td>true</td><td>Your client secret for the  Patchworks integration.</td></tr><tr><td><code>Environment</code></td><td>true</td><td>Your Whistl environment.</td></tr><tr><td><code>Grant type</code></td><td>true</td><td>Set to <code>client_credentials</code>.</td></tr><tr><td><code>Response authentication token key</code></td><td>true</td><td>Set to <code>access_token.</code></td></tr></tbody></table>

### Token authentication

When a user chooses to [add a connector instance](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) using **token** authentication, the credentials below are prompted:

<table><thead><tr><th>Credential</th><th width="145" data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>token</code></td><td>true</td><td>Enter the token provided for this integration.</td></tr><tr><td><code>Environment</code></td><td>true</td><td>Enter the required environment.</td></tr></tbody></table>


---

# 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/connectors-and-instances/patchworks-connectors/whistl-prebuilt-connector.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.