# Woodpecker Co

Woodpecker.co is a cold email tool that automates personalized email outreach and follow-ups for sales teams and agencies.

- **Category:** drip emails
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `WOODPECKER_CO`
- **Version:** 20260312_00

## Tools

### Add prospects to a campaign (v1)

**Slug:** `WOODPECKER_CO_ADD_PROSPECTS_TO_CAMPAIGN_V1`

Tool to add one or multiple prospects to a campaign. Use when you need to import prospects into a campaign's contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `force` | boolean | No | If true, adds prospects regardless of their global status |
| `campaign` | object | Yes | Campaign data specifying which campaign to add to |
| `file_name` | string | No | Name of the import batch (visible in the "imported" column) |
| `prospects` | array | Yes | List of prospects to add (max 20000 per request) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Campaign Step

**Slug:** `WOODPECKER_CO_DELETE_CAMPAIGN_STEP`

Tool to delete a non-initial campaign step that hasn't processed any prospects. Use when the campaign is in DRAFT or EDITED status and the step is unused.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `step_id` | string | Yes | The UUID of the step to delete. Must be a non-initial step (not the START step or first step after START) that has not processed any prospects. Use the Get Campaign action to retrieve step IDs. |
| `campaign_id` | integer | Yes | The unique identifier of the campaign containing the step to delete. Use the List Campaigns action to retrieve available campaign IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Prospects in Campaigns (v1)

**Slug:** `WOODPECKER_CO_GET_PROSPECTS_IN_CAMPAIGNS_V1`

Tool to retrieve prospects enrolled in specified campaigns. Use when you need to list prospects for given campaign IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | array | No | Filter to specific prospect IDs. Only prospects with these IDs will be returned. |
| `diff` | string | No | ISO-8601-like timestamp to filter by activity date (requires corresponding activity parameter). |
| `page` | integer | No | 1-based page number for pagination. |
| `sort` | string | No | Comma-separated sort fields with '+' for asc or '-' for desc (e.g., '+company,-last_contacted'). |
| `status` | string ("ACTIVE" | "BOUNCED" | "TO-CHECK" | "TO-REVIEW" | "REPLIED" | "AUTOREPLIED" | "BLACKLIST" | "PAUSED" | "INVALID") | No | Filter by prospect's status within the campaign (e.g., ACTIVE, REPLIED, BOUNCED). |
| `activity` | string ("OPENED" | "NOT-OPENED" | "CLICKED" | "NOT-CLICKED") | No | Activity filter. |
| `per_page` | integer | No | Number of results per page (default 100, max 1000). |
| `contacted` | boolean | No | Whether prospect was contacted in those campaigns. |
| `interested` | string ("INTERESTED" | "MAYBE-LATER" | "NOT-INTERESTED" | "NOT-MARKED") | No | Interest level filter. |
| `campaigns_id` | array | Yes | List of campaign IDs to retrieve prospects from. At least one campaign ID is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Available Webhook Events

**Slug:** `WOODPECKER_CO_LIST_AVAILABLE_WEBHOOK_EVENTS`

Tool to list all webhook event names supported by Woodpecker. Use before subscribing to ensure valid 'event' values (static catalog from docs).

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Campaigns V1

**Slug:** `WOODPECKER_CO_LIST_CAMPAIGNS_V1`

Tool to list campaigns. Use when you need to fetch campaigns with optional status or ID filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | array | No | Optional list of campaign IDs to filter by. Providing a single ID may return detailed information for that campaign. |
| `status` | array | No | Optional list of campaign statuses to filter by. Allowed values: RUNNING, DRAFT, EDITED, PAUSED, STOPPED, COMPLETED. |
| `company_id` | integer | No | Agency HQ only: client company context to act on. Sent as x-company-id header when provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pause Campaign

**Slug:** `WOODPECKER_CO_PAUSE_CAMPAIGN`

Tool to pause a campaign. Use when you need to temporarily stop sending prospects until resumed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | integer | Yes | Unique identifier of the campaign to pause. Must be a positive integer. Use 'List Campaigns' action to get available campaign IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Campaign

**Slug:** `WOODPECKER_CO_RUN_CAMPAIGN`

Tool to run a campaign and set its status to RUNNING. Use when you want to activate a configured campaign after final review.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | integer | Yes | Unique identifier of the campaign to run. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop Campaign

**Slug:** `WOODPECKER_CO_STOP_CAMPAIGN`

Tool to stop a campaign. Use when you need to halt prospect contacts by setting campaign status to STOPPED.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | The unique numeric identifier of the campaign to stop. Obtain this value from the List Campaigns endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |