Skip to main content
Woodpecker Co logo
  • Category: drip emails
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 8
  • Triggers: 0
  • Slug: WOODPECKER_CO
  • Version: 20261101_00

Tools

Slug: WOODPECKER_CO_ADD_PROSPECTS_TO_CAMPAIGN_V1Add one or multiple prospects to a campaign’s contact list. New prospects are also added to the global prospect list; forcing non-active prospects may allow them to be contacted again.

Input Parameters

boolean
If true, adds prospects regardless of their global status
object
required
Campaign data specifying which campaign to add to
string
Name of the import batch (visible in the “imported” column)
array
required
List of prospects to add (max 20000 per request)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WOODPECKER_CO_DELETE_CAMPAIGN_STEPTool 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

string
required
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.
integer
required
The unique identifier of the campaign containing the step to delete. Use the List Campaigns action to retrieve available campaign IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WOODPECKER_CO_GET_PROSPECTS_IN_CAMPAIGNS_V1Retrieve a page of prospects enrolled in specified Woodpecker campaigns, including campaign status and prospect details. Filter by prospect IDs, campaign status, contact status, interest or activity, and use sorting and pagination to narrow the results; up to 1,000 records can be requested per page.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WOODPECKER_CO_LIST_AVAILABLE_WEBHOOK_EVENTSList a static catalog of Woodpecker webhook event names. The catalog is not exhaustive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WOODPECKER_CO_LIST_CAMPAIGNS_V1List campaigns with optional status or ID filters. Certain authentication or permission failures are returned as an empty campaign list.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WOODPECKER_CO_PAUSE_CAMPAIGNTool to pause a campaign. Use when you need to temporarily stop sending prospects until resumed.

Input Parameters

integer
required
Unique identifier of the campaign to pause. Must be a positive integer. Use ‘List Campaigns’ action to get available campaign IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WOODPECKER_CO_RUN_CAMPAIGNRequest to start a configured Woodpecker campaign and set its status to RUNNING. Enrolled prospects are processed according to the campaign’s settings and delivery times; check the campaign status to confirm it started.

Input Parameters

integer
required
Unique identifier of the campaign to run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WOODPECKER_CO_STOP_CAMPAIGNStop a Woodpecker campaign by ID, setting its status to STOPPED and halting further prospect contact. The campaign can be resumed using the run operation.

Input Parameters

string
required
The unique numeric identifier of the campaign to stop. Obtain this value from the List Campaigns endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not