Woodpecker
The Woodpecker modules allow you to create, update, list, and delete the prospects in your Woodpecker account.
Getting Started with Woodpecker
Prerequisites
- A Woodpecker account
In order to use Woodpecker with Boost.space Integrator, it is necessary to have a Woodpecker account. You can create a Woodpecker account at woodpecker.co/signup.
Connecting Woodpecker to Boost.space Integrator
To connect your Woodpecker account to Boost.space Integrator you need to obtain the API Key from your Woodpecker account and insert it in the Create a connection dialog in the Boost.space Integrator module.
1. Login to your Woodpecker account.
2. Click Your Profile Icon > Settings > Integrations > API Keys > Create API Key.
3. Copy the API Key to your clipboard.
4. Go to Boost.space Integrator and open the Woodpecker module’s Create a connection dialog.
5. In the Connection name field, enter a name for the connection.
6. In the API Key field, enter the API key copied in step 3 and click Continue.
The connection has been established.
You do not have to add the webhooks in the Woodpecker as it is automatically done for you once you add and save an instant trigger module to your scenario.
Watch Prospect Reply
Triggers when a prospect replies or their status is manually changed to “Replied”.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Woodpecker account.
Watch Link Clicked
Triggers when a prospect clicks on a link in your email.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Woodpecker account.
Watch Email Opened
Triggers when a prospect opens your email (for the first time).
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Woodpecker account.
Watch Follow-up After Autoreply
Triggers when you get an auto-reply and you set a date to resume follow-ups.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Woodpecker account.
Watch Email Sent
Triggers when Woodpecker sends emails to a particular prospect.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Woodpecker account.
Prospect
Search Prospects
Searches a specific user or lists them all.
Connection
Establish a connection to your Woodpecker account.
Limit
Set the number of returned prospects Boost.space Integrator will return during one execution cycle.
Prospect
Select the prospect whose details you are searching for.
Status
Select the status of the prospect you are searching:
-
Active
-
Invalid
-
Bounced
-
Replied
-
Blacklist
Create a Prospect
Creates an array of new prospects.
Connection
Establish a connection to your Woodpecker account.
Prospects
Add the prospect:
Enter the email address of the prospect.
First Name
Enter the first name of the prospect.
Last Name
Enter the last name of the prospect.
Status
Select the status of the prospect:
-
Active
-
Invalid
-
Bounced
-
Replied
-
Blacklist
Company
Enter the company name to which the prospect belongs to.
Industry
Enter the industry type in which the prospect is working.
Website
Enter the website address of the prospect or the prospect’s company.
Tags
Enter the tags to filter the prospect when searching. For example, evangelist.
Title
Enter the prospect’s job title.
Phone
Enter the prospect’s phone number.
Address
Enter the prospect’s street address.
City
Enter the prospect’s city name.
State
Enter the prospect’s state name.
Country
Enter the prospect’s country name.
Snippet1-Snippet15
Enter any snippet provided for a prospect.
Update Prospects
Updates an array of existing prospects by ID.
Connection
Establish a connection to your Woodpecker account.
Prospect
Select the prospect whose details you want to update.
Prospects
Add the prospect:
Enter the email address of the prospect.
First Name
Enter the first name of the prospect.
Last Name
Enter the last name of the prospect.
Status
Select the status of the prospect:
-
Active
-
Invalid
-
Bounced
-
Replied
-
Blacklist
Company
Enter the company name to which the prospect belongs to.
Industry
Enter the industry type in which the prospect is working.
Website
Enter the website address of the prospect or the prospect’s company.
Tags
Enter the tags to filter the prospect when searching. For example, evangelist.
Title
Enter the prospect’s job title.
Phone
Enter the prospect’s phone number.
Address
Enter the prospect’s street address.
City
Enter the prospect’s city name.
State
Enter the prospect’s state name.
Country
Enter the prospect’s country name.
Snippet1-Snippet15
Enter any snippet provided for a prospect.
Delete a Prospect
Deletes an existing prospect.
Connection
Establish a connection to your Woodpecker account.
Prospect
Select the prospect you want to delete.
Watch Prospect Bounced
Triggers when your email was bounced and a prospect is marked as “Bounced”.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Woodpecker account.
Watch Prospect Invalid
Triggers when the prospect’s email address is marked as “Invalid”.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Woodpecker account.
Watch Prospect Interested
Triggers when a prospect is marked as “Interested”.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Woodpecker account.
Watch Prospect Maybe Later
Triggers when a prospect is marked as “Maybe later”.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Woodpecker account.
Watch Prospect Not Interested
Triggers when a prospect is marked as “Not Interested”.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Woodpecker account.
Watch Prospect Autoreplied
Triggers when an auto-reply is detected by Woodpecker or if you manually change a prospect’s status to “autoreplied”.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Woodpecker account.
Watch Prospect Blacklisted
Triggers when a prospect unsubscribe or when it is marked as “Blacklisted”.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Woodpecker account.
Other
Make an API Call
Performs an arbitrary authorized API call.
Connection
Establish a connection to your Woodpecker account.
URL
Enter a path relative to https://api.woodpecker.com/rest. For example: /v1/prospects
For the list of available endpoints, refer to the Woodpecker API Documentation.
Method
Select the HTTP method you want to use:
GET to retrieve information for an entry.
POST to create a new entry.
PUT to update/replace an existing entry.
PATCH to make a partial entry update.
DELETE to delete an entry.
Headers
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use – List Campaigns
The following API call returns all the campaigns from your Woodpecker account:
URL:
/v1/campaign_lists
Method:
GET
Matches of the search can be found in the module’s Output under Bundle > Body.
In our example, 4 campaigns were returned:
Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/marketing/woodpecker/).
