Manage prospects and automated cold-email outreach campaigns via the Woodpecker REST API.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

Woodpecker

Manage prospects and automated cold-email outreach campaigns via the Woodpecker REST API.

Woodpecker is a cold-email and sales-engagement platform. This tool reads your campaigns and prospects and enrolls new prospects into a running campaign, straight from an InTouch job or the assistant — no extra dependencies, just the Python standard library.

Base URL: https://api.woodpecker.co/rest
Auth: x-api-key: <apiKey> header (single API key, no OAuth)

Operations

`operation`	Method / Endpoint	What it does
`list_campaigns`	`GET /v1/campaign_list`	List the campaigns in your account.
`list_prospects`	`GET /v1/prospects`	List prospects from the global database, optionally filtered by `campaignId`, `status`, with `page` / `perPage` pagination.
`add_prospects_to_campaign`	`POST /v1/add_prospects_campaign`	Add a prospect (by `email`, plus optional `firstName`, `lastName`, `company`) to the campaign identified by `campaignId`.

Inputs

Name	Required	Notes
`apiKey`	yes	Woodpecker API key, sent in the `x-api-key` header.
`operation`	yes	One of `list_campaigns`, `list_prospects`, `add_prospects_to_campaign`.
`campaignId`	for add	Numeric campaign id. Optional filter for `list_prospects`.
`email`	for add	Prospect email address.
`firstName`	no	Prospect first name (add).
`lastName`	no	Prospect last name (add).
`company`	no	Prospect company (add).
`status`	no	`list_prospects` filter: `ACTIVE`, `BOUNCED`, `REPLIED`, `BLACKLIST`, `INVALID`.
`page`	no	`list_prospects` page number (1-based, default 1).
`perPage`	no	`list_prospects` records per page (default 100, max 1000).

Outputs

Field	Description
`result`	The raw JSON response body from Woodpecker, as a string.
`status`	The HTTP status code (e.g. `200`). Non-2xx codes are returned with the body so you can inspect the error.

API key setup

Log in to Woodpecker.
Go to Marketplace → Integrations → API Keys.
Create a new API key and copy it.
Pass it as the apiKey input. The tool sends it in the x-api-key header on every request.

Examples

List campaigns:

{ "apiKey": "wp_live_xxx", "operation": "list_campaigns" }

List the most recent prospects who replied:

{
  "apiKey": "wp_live_xxx",
  "operation": "list_prospects",
  "status": "REPLIED",
  "perPage": "50"
}

Add a prospect to campaign 12345:

{
  "apiKey": "wp_live_xxx",
  "operation": "add_prospects_to_campaign",
  "campaignId": "12345",
  "email": "[email protected]",
  "firstName": "Jane",
  "lastName": "Doe",
  "company": "Example Inc"
}

Notes

Standard-library only (urllib, json) — no requests, no install step.
Response bodies are capped at 5 MB.
HTTP errors (4xx/5xx) are returned as result + status rather than raising, so you can branch on the status in a downstream task. A transport-level failure (network/DNS) emits an error envelope and fails the step.

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: list_campaigns, list_prospects, add_prospects_to_campaign
`campaignId`	string	no	—	Numeric Woodpecker campaign id. Required for add_prospects_to_campaign; optional filter for list_prospects.
`email`	string	no	—	Prospect email address. Required for add_prospects_to_campaign.
`firstName`	string	no	—	Prospect first name for add_prospects_to_campaign (optional).
`lastName`	string	no	—	Prospect last name for add_prospects_to_campaign (optional).
`company`	string	no	—	Prospect company name for add_prospects_to_campaign (optional).
`status`	string	no	—	Global status filter for list_prospects: ACTIVE, BOUNCED, REPLIED, BLACKLIST, INVALID (optional).
`page`	string	no	—	1-based results page for list_prospects pagination (optional, default 1).
`perPage`	string	no	—	Records per page for list_prospects (optional, default 100, max 1000).