# Confluence

Prerequisites

* A Confluence account with admin access.
  * This account must not have two-step verification enabled, as 2FA also applies to API requests.
  * More information about API tokens:\
    <https://support.atlassian.com/atlassian-account/docs/manage-two-step-verification-for-your-atlassian-account/>

### Generating the credentials

1. Generate an API token associated with your Confluence account \
   <https://id.atlassian.com/manage-profile/security/api-tokens>\
   ![](https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2FbnIEUK23MOiuwbh8WufY%2FScreenshot%202024-03-19%20at%2011.08.37.png?alt=media\&token=0eb5db56-0f9b-4ba6-8930-e9623ffd6f26)
2. Copy the token and store it in a secure place. This is the access token that Coworker will need.![](https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2F3uOWCl2F5el5Uzir4qAm%2FScreenshot%202024-03-19%20at%2011.08.53.png?alt=media\&token=d7204e5b-dc1b-4d40-beaf-b3acd6a11e21)<br>
3. Export users to connect email and Confluence ID\
   1\. Go to <https://admin.atlassian.com/>\
   2\. Click Directory\
   3\. Click the three dots on the top right and click "Export Users"\
   4\. Change the users selector to only active users, and click export.\
   4\. When you receive the email, download the users and share them with the Coworker team in our shared Slack channel.

{% @arcade/embed flowId="JLO4qgQ5LhT4zPOLKoIv" url="<https://app.arcade.software/share/JLO4qgQ5LhT4zPOLKoIv>" %}

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2FOronUTJo28Pd9Jo3c9Fu%2FScreenshot%202024-03-19%20at%2009.44.25.png?alt=media&#x26;token=90a9e089-c692-4469-bc81-0a2f994c4a70" alt=""><figcaption></figcaption></figure>

### Information required for the Coworker connection:

* `email`: The email address associated with the Confluence account which created your API token
* `api_key`: The API token created above
* `base_url`: The base URL of your Confluence account, prefixed with https, eg. [https://mycompany.atlassian.net](https://villagelabs.atlassian.net)
* Share your list of Confluence users


---

# 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/confluence.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.