# Ashby

### Prequisites

* An Ashby account with sufficient permissions

Important note: the scope of the data which will be synchronized to Coworker is defined by the user behind the API key.\
We recommend that you create a service account which will have the right permissions, ie. no access to sensitive tasks/data.

### Generating the credentials

Log in as the service account which will make the API key, and go to the [API settings page](https://app.ashbyhq.com/admin/api/keys).

Click on "New" to make a new API key.

The scope required for a Coworker connection is the following:

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2FRzReL6djs7xthnhpd0ne%2FScreenshot%202024-08-01%20at%2012.21.13.png?alt=media&#x26;token=1b3b8de6-3af0-4d26-8b1f-8d1e3269790e" alt="" width="375"><figcaption><p>API Key Permissions</p></figcaption></figure>

Note on the read/write API key permission: Coworker relies on both the standard Ashby API, and webhook data to synchronize your activity.\
When the connection is made, webhooks will be created, [as can be seen here](https://app.ashbyhq.com/admin/api/webhooks). Please do not disable them, as Coworker would become unable to get real-time notifications of your activity.

The read permission on API keys is required for us to be able to verify the creation of these webhooks, as well as clean them up if the connection needs to be deleted.

No other write permission is required, Coworker will not be making any write operation on your data.

### Information required for the Village connection:

* `api_key`: the API key generated above
* `start_date`: the date of the first document that should be synchronized. No document updated before that will be synchronized. Format: ISO8601 date, ie. 2024-05-01T00:00:00Z


---

# 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://village-labs.gitbook.io/coworker-product-and-developer-docs/data-connections/ashby.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.
