For the complete documentation index, see llms.txt. This page is also available as Markdown.

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. In the top-right corner open Add-ons (Marketplace).

  2. Go to API & INTEGRATIONS → API keys.

  3. Click the green CREATE A KEY button and copy the generated key. You can label each key with the integration it is used for.

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.

See also the official guide: 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.

Last updated

Was this helpful?