> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/woodpecker.md).

# Woodpecker

How to get a Woodpecker.co API key and prepare your account for the Appmixer Woodpecker connector.

### 1. Create a Woodpecker account

Sign up with Woodpecker: <https://woodpecker.co>

### 2. Obtain an API key

1. Log in at <https://app.woodpecker.co>.
2. In the top-right corner open **Add-ons** (Marketplace).
3. Go to **API & INTEGRATIONS → API keys**.
4. Click the green **CREATE A KEY** button and copy the generated key. You can label each key with the integration it is used for.

{% hint style="info" %}
API keys are part of the **"API Key and Integrations"** add-on — it is included during the trial and a paid add-on on regular plans. If you don't see the API keys view, the add-on is not active on your account.
{% endhint %}

See also the official guide: [Generating API Key](https://woodpecker.co/help-center/en/articles/5223172-generating-api-key).

### 3. Connect Woodpecker components in Appmixer

Use the copied key as the **API Key** when connecting any Woodpecker component in Appmixer. The key is sent in the `x-api-key` header and validated against the Woodpecker `GET /v1/me` endpoint.

### 4. Connect a mailbox (required for campaigns)

Campaign components (Create Campaign, Run/Pause/Stop Campaign) and the mailbox components require at least one **connected email account** in Woodpecker:

1. In the Woodpecker panel open **Settings → Email accounts** (gear icon).
2. Click **Connect an email account** and follow the provider flow (Google/Microsoft OAuth or manual SMTP/IMAP).
3. The account then appears in the **List Mailboxes** component; its `id` is the **Email Account ID** the **Create Campaign** component requires.


---

# 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://docs.appmixer.com/connector-configuration/woodpecker.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.