IN THIS ARTICLE:
Thanks to webhooks you are able to subscribe to every event related to prospects. So your system will update information every time a prospect opens, replies, or clicks on your email.
API Key is a part of an API Key and Integrations add-on, click here to learn how to get it on Marketplace »
How to subscribe to Woodpecker webhooks
If you want to receive notifications about what happened in Woodpecker, use the following URL & request to subscribe to our webhooks:
POST https://api.woodpecker.co/rest/v1/webhooks/subscribe
Notice there is no trailing slash at the end of this URL.
Subscription request:
{
"target_url": "https://customer-endpoint.com/unique_target_url",
"event": "<method_name>"
}
Replace <method_name> with one of the events described below. Remember, you have to subscribe to each event separately.
Remember there must be content-type: application/json header added to the request.
After you subscribe to the webhook, you'll get a 201 Created status and the following response:
{
"target_url": "https://customer-endpoint.com/unique_target_url",
"event": "<method_name>",
"message": "Subscribed."
}
If you have previously subscribed to the specific webhook with the same target URL, you'll get 409 Conflict status and a following response:
{
"status": {
"status": "ERROR",
"code": "E_WRONG_PARAM",
"msg": "Event defined for this url."
}
}How to unsubscribe from Woodpecker webhooks
If you no longer want to receive Woodpecker notifications, use the URL & request shown below.
POST https://api.woodpecker.co/rest/v1/webhooks/unsubscribe
{
"target_url": "https://customer-endpoint.com/unique_target_url",
"event": "<method_name>"
}
Remember, you have to unsubscribe from every event you've subscribed separately. We don't provide a bulk unsubscription for all your events.
Rate limits
You can subscribe to the same event up to three times per one account. If you reach the limit, you'll get the following error message:
You can only subscribe to the same webhook 3 times per one account.
You can check which events you subscribed to by using a dedicated endpoint in API 2.0. A detailed documentation is here.
Events you can subscribe to:
prospect_replied - when a reply is detected or prospect's status is manually changed to 'Responded'
prospect_blacklisted - when prospect's status is changed to 'Blacklisted'
prospect_opt_out - when a prospect unsubscribes or their status is manually changed to "Opt-out"
prospect_bounced - when a bounce is detected or prospect's status is manually changed to 'Bounced'
prospect_invalid - when prospect's email address is marked as 'Invalid'
prospect_autoreplied - when an autoreply is detected or prospect's status is manually changed to 'Autoreplied'
prospect_saved - when a new prospect is added to Woodpecker or there's an update of an existing one
prospect_non_responsive - when a prospect's status is changed to 'Nonresponsive'
link_clicked - when a prospect clicks on a link in your email
email_opened - when a prospect opens your email
prospect_interested - when prospect's interest level changes to 'Interested'
prospect_maybe_later - when prospect's interest level changes to 'Maybe later'
prospect_not_interested - when prospect's interest level changes to 'Not interested'
followup_after_autoreply - when you get an autoreply and you set a date to resume follow-ups
campaign_sent - when an email to a particular prospect is sent
task_created - when a manual task for a specific prospect is created
task_done - when a manual task is marked as done
task_ignored - when a manual task is marked as ignored
secondary_replied - when a secondary reply is detected
campaign_completed - when a campaign status is changed to 'Completed'
Webhook payload - common fields
Each webhook returns a response in a JSON format. Webhook payload consist of common fields and some fields specific to the webhook.
method - string, webhook event name.
prospect - JSON object, a set of information about prospect.
id - number, prospect ID.
firm_id - number, company's ID.
email - string, prospect's email address.
first_name - string, prospect's first name.
last_name - string, prospect's last name.
company - string, prospect's company.
website - string, prospect's website.
linkedin_url - string, a link to the prospect's LinkedIn profile.
tags - string, prospect's tags.
title - string, prospect's title.
phone - string, prospect's phone number.
address - string, prospect's home address.
city - string, prospect's city.
country - string, prospect's country.
snippet1...snippet15 - string, custom fields.
snippet_labels - JSON object, a list of custom snippet names and their values.
industry - string, prospect's industry.
state - string, prospect's state.
last_contacted - string, an information about the the time when last email was sent to the prospect.
status - string, prospect's status.
in_campaign - number, number of campaigns prospect is added to.
emails_sent - number, total number of emails sent to the prospect from all campaigns.
imported - string, a name of a file prospect was imported from.
interested - string, interest level.
campaign_id - number, a campaign ID a specific webhook comes from.
campaign_name - string, a campaign name a specific webhook comes from.
campaign_email - string, an email address campaign is sent from.
campaign_emails - array, multiple email addresses campaign is sent from.
campaign_email_sent - number, number of emails sent from campaign a specific webhook comes from.
timestamp - string, information about a time when a specific webhook was generated.
Note:
Snippet labels are shown only if you set custom snippet names in app. Otherwise the object will be empty. They carry the same value as snippet 1 to 15 (if filled).
Prospect's status can have one of the following values: ACTIVE, PAUSED, BOUNCED, INVALID, REPLIED, AUTOREPLIED, BLACKLIST.
Interest level can have one of the following values: INTERESTED, MAYBE_LATER, NOT_INTERESTED.
Campaign-related parameters (campaign_id, campaign_name, campaign_email, campaign_email_sent) have values only if webhook was generated in a specific campaign.
prospect_replied
Sample result:
[ {
"method": "prospect_replied",
"prospect": {
"id": 1234567890,
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "REPLIED",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 1,
"step": 1
},
"email" : {
"id": 191867492,
"mail_id": 123807,
"subject": "reply message subject",
"sender": "Reply Sender",
"email": "[email protected]",
"date": "2022-04-07T16:00:00+0200",
"message": "reply content"
},
"timestamp": "2022-04-07T16:06:10+0200",
"firm_id": 123456
} ]
prospect_blacklisted
Sample result:
[ {
"method": "prospect_blacklisted",
"prospect": {
"id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "BLACKLIST",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 1,
"step": 1
},
"timestamp": "2022-04-07T16:06:10+0200"
"firm_id": 123456,
} ]
prospect_opt_out
Sample result:
[ {
"method": "prospect_opt_out",
"prospect": {
"id": 123456789,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity Inc.",
"website": "bachmanity.com",
"linkedin_url": "https://www.linkedin.com/in/erlichbachman/",
"tags": "#visionary",
"title": "Mr",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "OPT_OUT",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]"
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 2,
"step": 1
},
"timestamp": "2022-04-27T08:35:22+0200"
"firm_id": 123456,
} ]
prospect_bounced
Sample result:
[ {
"method": "prospect_bounced",
"prospect": {
"id": 123456789,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity Inc.",
"website": "bachmanity.com",
"linkedin_url": "https://www.linkedin.com/in/erlichbachman/",
"tags": "#visionary",
"title": "Mr",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "BLACKLIST",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]"
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 2,
"step": 1
},
"timestamp": "2022-04-27T08:35:22+0200"
"firm_id": 123456,
} ]
prospect_invalid
Sample result:
[ {
"method": "prospect_invalid",
"prospect": {
"id": 123456789,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity Inc.",
"website": "bachmanity.com",
"linkedin_url": "https://www.linkedin.com/in/erlichbachman/",
"tags": "#visionary",
"title": "Mr",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "INVALID",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]"
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 2,
"step": 1
},
"timestamp": "2022-04-27T08:35:22+0200"
"firm_id": 123456,
} ]
prospect_autoreplied
Sample result:
[ {
"method": "prospect_autoreplied",
"prospect": {
"id": 1234567890,
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "AUTOREPLIED",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "INTERESTED",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
],
"campaign_email_sent": 1,
"step": 1
},
"email" : {
"id": 191867492,
"mail_id": 123807,
"subject": "reply message subject",
"sender": "Reply Sender",
"email": "[email protected]",
"date": "2022-04-07T16:00:00+0200",
"message": "reply content"
},
"timestamp": "2022-04-07T16:06:10+0200",
"firm_id": 123456
} ]
This payload may also include a "followup_after" parameter if the date of resuming follow ups is set.
prospect_saved
Sample result:
[ {
"method": "prospect_saved",
"prospect": {
"id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "AUTOREPLIED",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "INTERESTED",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 1,
"step": 1
},
"timestamp": "2022-04-07T16:06:10+0200"
"firm_id": 123456,
} ]
prospect_non_responsive
Sample result:
[ {
"method": "prospect_non_responsive",
"prospect": {
"id": 385986296,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2023-06-20T15:02:08+0200",
"status": "NON_RESPONSIVE",
"in_campaign": 1,
"emails_sent": 1,
"imported": "saasinamerica.csv",
"interested": "",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 1,
"step": 1
},
"timestamp": "2023-06-20T15:05:31+0200"
"firm_id": 123456,
} ]
link_clicked
Sample result:
[ {
"method": "link_clicked",
"email_no": "#2",
"step": 1,
"click_url": "https://onet.pl",
"prospect": {
"id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "ACTIVE",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "INTERESTED",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 1,
"step": 1
},
"timestamp": "2022-04-07T16:06:10+0200"
"firm_id": 123456,
} ]
Webhook specific response data type:
email_no - number, number of email sent from which a click comes from.
step - number, number of step in campaign from which a click comes from.
click_url - string, a link that was clicked by the prospect.
Note:
For a better understanding of an email number and step parameters check our article about Browsing campaigns via API.
email_opened
Sample result:
[ {
"method": "email_opened",
"email_no": "#2",
"step": 1,
"prospect": { "id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "ACTIVE",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "INTERESTED",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 1,
"step": 1
},
"open_count": 2,
"open_date_latest": "2022-04-27T00:00:00+0200",
"timestamp": "2022-04-27T12:11:00+0200"
"firm_id": 123456,
} ]
Webhook specific response data type:
email_no - number, number of email sent from which an open comes from.
step - number, number of step in campaign from which an open comes from.
open_count - number, number of opens of this specific email.
open_date_latest - string, timestamp of the latest email open.
Note:
For a better understanding of an email number and step parameters check our article about Browsing campaigns via API.
prospect_interested
Sample result:
[ {
"method": "prospect_interested",
"prospect": {
"id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "REPLIED",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "INTERESTED",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 1,
"step": 1
},
"timestamp": "2022-04-07T16:06:10+0200"
"firm_id": 123456,
} ]
prospect_maybe_later
Sample result:
[ {
"method": "prospect_maybe_later",
"prospect": {
"id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "REPLIED",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "MAYBE_LATER",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 1,
"step": 1
},
"timestamp": "2022-04-07T16:06:10+0200"
"firm_id": 123456,
} ]
prospect_not_interested
Sample result:
[ {
"method": "prospect_not_interested",
"prospect": {
"id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "REPLIED",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "NOT_INTERESTED",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 1,
"step": 1
},
"timestamp": "2022-04-07T16:06:10+0200"
"firm_id": 123456,
} ]
followup_after_autoreply
Sample result:
[ {
"method": "followup_after_autoreply",
"prospect": {
"id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "ACTIVE",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 2,
"step": 1,
"followup_after": "2022-12-24T00:00:00+0100"
},
"timestamp": "2022-04-07T16:06:10+0200"
"firm_id": 123456,
} ]
Webhook specific response data type:
followup_after - string, a scheduled date of sending next follow-up.
campaign_sent
Sample result:
[
{
"method": "campaign_sent",
"prospect": {
"id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "ACTIVE",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "",
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 1
},
"email": {
"id": 395832444,
"campaign_id": 1156783,
"message_id": 1174549286492947394,
"name_from": "Jared Dunn",
"email_from": "[email protected]",
"name_to": "Erlich Bachman",
"email_to": "[email protected]",
"email_cc": "",
"email_bcc": "",
"subject": "This is subject of the message.",
"sent": "2016-03-09T21:05:28+0100",
"host": "x1.awm.host.com",
"number": 2,
"step": 1,
"message": "<div>This is my email in HTML format.</div>"
},
"timestamp": "2016-03-09T21:05:30+0100"
"firm_id": 123456,
}
]
Webhook specific response data type:
email - JSON object, information about the specific message that was sent to the prospect.
id - number, message ID assigned by Woodpecker.
campaign_id - number, campaign ID.
message_id - number, message_id assigned by SMTP server.
name_from - string, a name of the person on whom behalf a specific message is sent.
email_from - string, an email address from which a specific email is sent.
name_to - string, prospect's name.
email_to - string, prospect's email address.
email_bcc - string. a blind carbon copy email added to the campaign.
email_cc - string, a carbon copy email added to the campaign.
subject - string, message subject.
sent - string, timestamp of sending the message.
host - string, sending host.
number - number, number of email sent.
step - number, number of step in campaign from which a click comes from.
Note:
For a better understanding of an email number and step parameters check our article about Browsing campaigns via API.
task_created
Sample result:
[ {
"prospect": {
"id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "ACTIVE",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "",
"campaign_id": "",
"campaign_name": "",
"campaign_email": "",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 0,
"step": 1
},
"campaign": {
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"sent_from": "[email protected]"
"sent_from_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
},
"task": {
"type": "LINKEDIN",
"name": "Send connection request",
"message": "Hi Erlich, I'd like to join your connection network.",
"due_date": "2021-11-11T21:37:00+0100"
},
"method": "task_created",
"timestamp": "2022-04-28T11:34:05+0200"
"firm_id": 123456,
} ]
task_done
Sample result:
[ {
"prospect": {
"id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "ACTIVE",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "",
"campaign_id": "",
"campaign_name": "",
"campaign_email": "",
"campaign_emails": "",
"campaign_email_sent": 0,
"step": 1
},
"campaign": {
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"sent_from": "[email protected]",
"sent_from_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
},
"task": {
"type": "LINKEDIN",
"name": "Send connection request",
"message": "Hi Erlich, I'd like to join your connection network.",
"due_date": "2021-11-11T21:37:00+0100"
},
"method": "task_done",
"timestamp": "2022-04-28T11:34:05+0200"
"firm_id": 123456,
} ]
task_ignored
Sample result:
[ {
"prospect": {
"id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "ACTIVE",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "",
"campaign_id": "",
"campaign_name": "",
"campaign_email": "",
"campaign_emails": "",
"campaign_email_sent": 0,
"step": 1
},
"campaign": {
"campaign_id": 1156783,
"campaign_name": "SaaS in America",
"sent_from": "[email protected]",
"sent_from_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
},
"task": {
"type": "LINKEDIN",
"name": "Send connection request",
"message": "Hi Erlich, I'd like to join your connection network.",
"due_date": "2021-11-11T21:37:00+0100"
},
"method": "task_ignored",
"timestamp": "2022-04-28T11:34:05+0200"
"firm_id": 123456,
} ]
secondary_replied
Sample result:
[ {
"method": "secondary_replied",
"prospect": {
"id": 1234567890,
"email": "[email protected]",
"first_name": "Erlich",
"last_name": "Bachman",
"company": "Bachmanity",
"website": "https://bachmanity.com",
"linkedin_url": "https://linkedin.com/erlich-bachman",
"tags": "#visionary",
"title": "CEO",
"phone": "+1 987-654-321",
"address": "700 Welch Road",
"city": "Palo Alto",
"country": "United States",
"snippet1": "You are running a successful startup incubator Bachmanity",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": "You are running a successful startup incubator Bachmanity"
},
"industry": "SaaS",
"state": "California",
"last_contacted": "2016-03-09T21:05:28+0100",
"status": "REPLIED",
"in_campaign": 1,
"emails_sent": 3,
"imported": "saasinamerica.csv",
"interested": "",
"campaign_id": "123456",
"campaign_name": "My super campaign",
"campaign_email": "[email protected]",
"campaign_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
"campaign_email_sent": 1,
"step": 1
},
"secondary_prospect": {
"id": 1234567896,
"email": "[email protected]",
"first_name": "",
"last_name": "",
"company": "",
"website": "",
"linkedin_url": "",
"tags": "#SECONDARYEMAIL",
"title": "",
"phone": "",
"address": "",
"city": "",
"country": "",
"snippet1": "",
"snippet2": "",
"snippet3": "",
"snippet4": "",
"snippet5": "",
"snippet6": "",
"snippet7": "",
"snippet8": "",
"snippet9": "",
"snippet10": "",
"snippet11": "",
"snippet12": "",
"snippet13": "",
"snippet14": "",
"snippet15": "",
"snippet_labels": {
"my snippet label": ""
},
"industry": "",
"state": "",
"last_contacted": "",
"status": "BLACKLISTED",
"in_campaign": null,
"emails_sent": null,
"imported": "",
"interested": "",
"campaign_id": "",
"campaign_name": "",
"campaign_email": "",
"campaign_emails": "",
"campaign_email_sent": null,
"step": null
},
"timestamp": "2022-04-07T16:06:10+0200"
"firm_id": 123456,
} ]
Webhook specific response data type:
campaign - JSON object, information about campaign a specific task comes from.
campaign_id - number, campaign ID.
campaign_name - string, campaign name.
sent_from - string, an email address campaign is sent from.
sent_from_emails - array, email addresses campaign is being sent from.
task - JSON object, information about a task that was created.
type - string, task type.
name - string, task name.
message - string, task message/description.
due_date - string, task due date.
secondary_prospect - JSON object, information about the prospect who actually replied to your email (in case of secondary reply only).
Note:
Available task types: GENERIC, LINKEDIN, CALL, SMS.
Learn more about manual tasks in campaign with this article.
campaign_completed
Sample result:
[ {
"campaign": {
"campaign_id": 1234567,
"campaign_name": "My super campaign",
"sent_from": "[email protected]",
"sent_from_emails": [
"[email protected]",
"[email protected]",
"[email protected]",
]
},
"method": "campaign_completed",
"timestamp": "2023-01-23T12:23:48+0100"
"firm_id": 123456,
} ]
Webhook specific response data type:
campaign - JSON object, information about campaign that just have been completed.
campaign_id - number, campaign ID.
campaign_name - string, campaign name.
sent_from - string, an email address campaign is sent from.
sent_from_emails - array, email addresses the campaign is sent from.
Slack webhooks
If you want to receive notifications about what happened in Woodpecker to your Slack channel, use the following URL & request to subscribe to our webhooks:
POST 'https://app.woodpecker.co/rest/v1/slack_webhooks/subscribe'
Here's a tutorial from Slack on how to set up an app from their side and generate a webhook URL, which can be registered in Woodpecker.
Events you can subscribe to:
prospect_replied - when a reply is detected or prospect's status is manually changed to 'Responded'
Subscription request (in cURL):
curl --location --request POST 'https://app.woodpecker.co/rest/v1/slack_webhooks/subscribe' \
--header 'x-api-key: WOODPECKER_API_KEY' \
-H 'Content-type: application/json' --data '{
"target_url": "SLACK_TARGET_URL",
"event": "prospect_replied"
}'
Sample response:
"blocks": [
{
"type": "header",
"text": {
"type": "plain_text",
"text": "New reply"
}
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*campaign_id:*\n1156783"
},
{
"type": "mrkdwn",
"text": "*campaign_name:*\nSaaS in America"
},
{
"type": "mrkdwn",
"text": "*campaign_email:*\[email protected]"
}
]
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*mail_id:*\n123807"
},
{
"type": "mrkdwn",
"text": "*Date:*\n2022-04-07T16:00:00+0200"
},
{
"type": "mrkdwn",
"text": "*Sender:*\nReply Sender"
},
{
"type": "mrkdwn",
"text": "*Email:*\[email protected]"
}
]
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Subject:*\nreply message subject"
}
]
},
{
"type": "section",
"fields": [
{
"type": "mrkdwn",
"text": "*Email content:*\n`Email content`"
}
]
}
]