# Woodpecker Docs > Woodpecker developer documentation for integrating with the public API, webhooks, MCP server, and CLI. Use these resources to manage campaigns, prospects, mailboxes, domains, reports, and other Woodpecker features programmatically. This file contains links to documentation sections following the llmstxt.org standard. ## Table of Contents - [Introduction](https://developers.woodpecker.co/docs.md): The Woodpecker API provides a RESTful infrastructure that allows you to manage your account, prospect list, campaigns, reports, mailboxes, and clie... - [Authentication](https://developers.woodpecker.co/docs/getting-started/authentication.md): All requests must be authenticated using an API key in the `x-api-key` header. - [Error codes](https://developers.woodpecker.co/docs/getting-started/error-codes.md): When interacting with our API, you may encounter error responses that follow standard HTTP status codes, providing meaningful feedback to help diag... - [Rate limiting](https://developers.woodpecker.co/docs/getting-started/rate-limiting.md): Our API supports unlimited monthly calls while processing one request at a time and queuing up to 6 additional requests. If you exceed these limits... - [Changelog](https://developers.woodpecker.co/docs/changelog.md): - August 11 - **LinkedIn post engagement collection.** New API endpoints let you collect profiles and engagement data of people who reacted to or c... - [Blacklisting](https://developers.woodpecker.co/docs/blacklist-domains-emails.md): This feature allows you to specify domains and emails that you don't want to contact again as long as they remain on the blacklist. Prospects whose... - [Delete domains from the blacklist](https://developers.woodpecker.co/docs/blacklist-domains-emails/delete-domains.md): Remove specific domains from the blacklist. Removing a domain from the list doesn't change the status of a prospect if it was previously set to `BL... - [Delete emails from the blacklist](https://developers.woodpecker.co/docs/blacklist-domains-emails/delete-emails.md): Remove specific emails from the blacklist. Removing an email from the list doesn't change the status of a prospects if it was previously set to `BL... - [Get blacklisted domains](https://developers.woodpecker.co/docs/blacklist-domains-emails/get-domains.md): Retrieve a paginated list of all blacklisted domains for the authenticated account. You can use the `domain_filter` parameter to check whether spec... - [Get blacklisted emails](https://developers.woodpecker.co/docs/blacklist-domains-emails/get-emails.md): Retrieve a paginated list of all blacklisted emails for the authenticated account. You can use the `email_filter` parameter to check whether specif... - [Blacklist domains](https://developers.woodpecker.co/docs/blacklist-domains-emails/post-domains.md): Add domains to the blacklist. Blacklisting a domain does not immediately change the status of existing prospects. Instead, it prevents contacting p... - [Blacklist emails](https://developers.woodpecker.co/docs/blacklist-domains-emails/post-emails.md): Add emails to the blacklist. Blacklisting an email does not immediately change the status of existing prospects. Instead, it prevents contacting sp... - [Delete campaign step](https://developers.woodpecker.co/docs/campaigns/DELETE-campaign-step.md): This endpoint lets you delete a campaign step. You can delete `EMAIL` and `LINKEDIN` steps that haven't processed any prospects and are not the fir... - [Delete campaign](https://developers.woodpecker.co/docs/campaigns/DELETE-campaign.md): This request will delete a campaign. You can delete a campaign in any status, except if it is part of a [workflow](https://woodpecker.co/help-cente... - [Get a list of campaigns](https://developers.woodpecker.co/docs/campaigns/GET-campaign-list-v1.md): :::warning - [Get campaign statistics](https://developers.woodpecker.co/docs/campaigns/GET-campaign-stats-v1.md): :::warning - [Get campaign](https://developers.woodpecker.co/docs/campaigns/GET-campaign.md): Fetch a campaign. Use this endpoint to review your campaign settings, including sending limits, attached mailboxes and LinkedIn accounts; content a... - [Update step version](https://developers.woodpecker.co/docs/campaigns/PATCH-campaign-step-version.md): Use this request to update a step version. - [Update step](https://developers.woodpecker.co/docs/campaigns/PATCH-campaign-step.md): Use this request to update an `EMAIL` step's delivery times. This request replaces the entire `delivery_times` object. Any existing values not incl... - [Update campaign settings](https://developers.woodpecker.co/docs/campaigns/PATCH-campaign.md): Use this request to update campaign-wide settings such as assigned email accounts, sending limits, timezone, and more. The endpoint allows for part... - [Add campaign step](https://developers.woodpecker.co/docs/campaigns/POST-add-step.md): This endpoint allows you to add a new step at the end of a campaign, as long as the parent step has not yet processed any prospects. - [Create campaign](https://developers.woodpecker.co/docs/campaigns/POST-create-campaign.md): Create a **multichannel, LinkedIn or email campaign** with a sequence of personalized follow-up messages and customizable delivery settings. Config... - [Edit campaign](https://developers.woodpecker.co/docs/campaigns/POST-editable-campaign.md): This action changes the status of a campaign to the `EDITED` status. It allows you to make changes to a campaign - modify its general settings, con... - [Pause campaign](https://developers.woodpecker.co/docs/campaigns/POST-pause-campaign.md): This request will change the campaign status to `PAUSED` and will halt any further contact with prospects until the status is changed back to `RUNN... - [Run campaign](https://developers.woodpecker.co/docs/campaigns/POST-run-campaign.md): This request starts a campaign and changes its status to `RUNNING`. Prospects enrolled in the campaign will be processed based on the campaign sett... - [Stop campaign](https://developers.woodpecker.co/docs/campaigns/POST-stop-campaign.md): This request will change the campaign status to `STOPPED` and will halt any further contact with prospects until the status is changed back to `RUN... - [Clear Bounce Shield threshold](https://developers.woodpecker.co/docs/campaigns/bounce-shield/DELETE-bounce-shield-threshold.md): Clear the Bounce Shield Monitor bounce rate threshold from a campaign, effectively disabling the Bounce Shield Monitor. - [Get Bounce Shield threshold](https://developers.woodpecker.co/docs/campaigns/bounce-shield/GET-bounce-shield-threshold.md): Retrieve the Bounce Shield Monitor bounce rate threshold configured for a campaign. The response returns an integer representing the percentage thr... - [Set Bounce Shield threshold](https://developers.woodpecker.co/docs/campaigns/bounce-shield/PUT-bounce-shield-threshold.md): Set or replace the Bounce Shield Monitor bounce rate threshold for a campaign. Provide the threshold as an integer representing a percentage, for e... - [Bounce Shield](https://developers.woodpecker.co/docs/campaigns/bounce-shield/overview.md): Bounce Shield Monitor can automatically pause a campaign when the campaign bounce rate reaches the configured threshold. Use these endpoints to ret... - [Campaigns](https://developers.woodpecker.co/docs/campaigns.md): The `v2/campaigns` API allows you to manage your **email and LinkedIn campaigns** in Woodpecker. You can: - [Get inbox messages](https://developers.woodpecker.co/docs/inbox/get-inbox-messages.md): Retrieve a paginated list of email messages available in the Woodpecker inbox. You can use the available [parameters](#parameters) to narrow down t... - [Inbox](https://developers.woodpecker.co/docs/inbox.md): The Inbox API allows you to retrieve and reply to messages received in your Woodpecker inbox. You can: - [Reply to a message](https://developers.woodpecker.co/docs/inbox/post-reply-message.md): This endpoint allows you to reply to a message retrieved from the Woodpecker inbox. - [Lead Finder](https://developers.woodpecker.co/docs/lead-finder.md): Lead Finder is an API workflow for finding potential clients and turning them into richer prospect records. It has two entry points: search for new... - [Get lead enrichment](https://developers.woodpecker.co/docs/lead-finder/lead-search-and-enrichment/get-lead-enrichment.md): Retrieve one lead enrichment batch by its `uuid`. Use this endpoint after [queueing lead enrichments](queue-lead-enrichments.mdx) when you already ... - [Get search criteria values](https://developers.woodpecker.co/docs/lead-finder/lead-search-and-enrichment/get-search-criteria-values.md): Retrieve allowed values for a selected Lead Finder criterion. Use this endpoint for `enumerated` criteria returned by [Get search criteria](get-sea... - [Get search criteria](https://developers.woodpecker.co/docs/lead-finder/lead-search-and-enrichment/get-search-criteria.md): Retrieve the current list of Lead Finder criteria you can use when building a [lead search](post-search-leads.mdx) request. The response is grouped... - [List lead enrichments](https://developers.woodpecker.co/docs/lead-finder/lead-search-and-enrichment/list-lead-enrichments.md): List lead enrichment batches requested for the authenticated account. Use this endpoint after [queueing lead enrichments](queue-lead-enrichments.md... - [Lead search and enrichment](https://developers.woodpecker.co/docs/lead-finder/lead-search-and-enrichment/overview.md): Use this flow when you want to find leads who match a target audience and are not already coming from your Woodpecker prospects database. - [Search leads](https://developers.woodpecker.co/docs/lead-finder/lead-search-and-enrichment/post-search-leads.md): Search for people who match one or more Lead Finder criteria. This endpoint returns a compact result set intended for discovery, filtering, and sel... - [Queue lead enrichments](https://developers.woodpecker.co/docs/lead-finder/lead-search-and-enrichment/queue-lead-enrichments.md): Queue one or more Lead Finder search results for enrichment. This endpoint starts an asynchronous lead enrichment batch and returns a batch `uuid` ... - [Get prospect enrichment](https://developers.woodpecker.co/docs/lead-finder/prospect-enrichment/get-prospect-enrichment.md): Retrieve status details for a prospect enrichment batch. Use this endpoint after [queueing prospect enrichments](queue-prospect-enrichments.mdx) wh... - [List prospect enrichments](https://developers.woodpecker.co/docs/lead-finder/prospect-enrichment/list-prospect-enrichments.md): List prospect enrichment statuses for the authenticated account. Use this endpoint after [queueing prospect enrichments](queue-prospect-enrichments... - [Prospect enrichment](https://developers.woodpecker.co/docs/lead-finder/prospect-enrichment/overview.md): Use this flow when you **already have prospects in Woodpecker and want to enrich those existing records** with additional data. If you need to find... - [Queue prospect enrichments](https://developers.woodpecker.co/docs/lead-finder/prospect-enrichment/queue-prospect-enrichments.md): Queue one or more prospects for enrichment. This endpoint starts an asynchronous prospect enrichment batch and returns a batch `uuid` that you can ... - [Get a collection job](https://developers.woodpecker.co/docs/linkedin/get-collection-job.md): Retrieve a collection job by the UUID returned when you [collect profiles from posts](post-collect-profiles.mdx). Use this endpoint to monitor a kn... - [List collection jobs](https://developers.woodpecker.co/docs/linkedin/get-collection-jobs.md): Retrieve collection jobs for the authenticated Woodpecker account. Use this endpoint after [collecting profiles from posts](post-collect-profiles.m... - [Get a list of LinkedIn accounts](https://developers.woodpecker.co/docs/linkedin/get-linkedin-accounts.md): Retrieve a list of LinkedIn accounts associated with your Woodpecker account, including each account's status, user information, and subscription l... - [LinkedIn](https://developers.woodpecker.co/docs/linkedin/overview.md): Use these endpoints to collect profiles and engagement data from posts, and retrieve accounts connected to Woodpecker. - [Collect profiles from posts](https://developers.woodpecker.co/docs/linkedin/post-collect-profiles.md): Collect LinkedIn profiles of people who reacted to or commented on selected posts and save the results to a new [List in Woodpecker](https://woodpe... - [Mailbox connection batch status](https://developers.woodpecker.co/docs/mailboxes/get-batch-summary.md): Review the status of the submitted connection batch using the batch ID returned by [rest/v2/mailboxes/manual_connection/bulk](post-mailboxes.mdx). ... - [Get a mailbox](https://developers.woodpecker.co/docs/mailboxes/get-mailbox.md): Retrieve a configuration of a specific email account connected to your account. Each object contains details of a specific SMTP or IMAP and informa... - [Get a list of mailboxes](https://developers.woodpecker.co/docs/mailboxes/get-mailboxes.md): Retrieve a list and configuration of email accounts connected to your account. Each object contains details of SMTP or IMAP and information about t... - [Mailboxes](https://developers.woodpecker.co/docs/mailboxes.md): The `/mailboxes` API enables you to manage mailboxes associated with your account. Use these endpoints to list, retrieve, connect, and update mailb... - [Delete a Microsoft Graph credential](https://developers.woodpecker.co/docs/mailboxes/microsoft/delete-credentials.md): Delete a Microsoft Graph app-only credential. Woodpecker blocks deletion when the credential is used by an active Microsoft mailbox. - [List Microsoft Graph credentials](https://developers.woodpecker.co/docs/mailboxes/microsoft/get-credentials.md): Retrieve Microsoft Graph app-only credentials saved for your account. Use this endpoint to find the `credential_id` required when connecting Micros... - [Microsoft mailboxes](https://developers.woodpecker.co/docs/mailboxes/microsoft/overview.md): Use the Microsoft mailbox endpoints to connect Microsoft 365 mailboxes with Microsoft Graph app-only authentication. This workflow uses a Microsoft... - [Update a Microsoft Graph credential](https://developers.woodpecker.co/docs/mailboxes/microsoft/patch-credentials.md): Update a Microsoft Graph app-only credential. You can rename the credential, or rotate its client secret by sending both `client_secret` and `secre... - [Create a Microsoft Graph credential](https://developers.woodpecker.co/docs/mailboxes/microsoft/post-credentials.md): Create a Microsoft Graph app-only credential for connecting Microsoft mailboxes. Before saving the credential, Woodpecker verifies that the provide... - [Add Microsoft mailboxes in bulk](https://developers.woodpecker.co/docs/mailboxes/microsoft/post-ms-mailboxes.md): Connect one or more Microsoft mailboxes with Microsoft Graph app-only authentication. Use a `credential_id` from [List credentials](get-credentials... - [Add mailboxes in bulk](https://developers.woodpecker.co/docs/mailboxes/post-mailboxes.md): Connect one or multiple mailboxes to your account by providing SMTP/IMAP credentials along with optional sending configurations. This endpoint enab... - [Update mailbox](https://developers.woodpecker.co/docs/mailboxes/update-mailbox.md): Update the details of an email account connected to your account. Currently, the property that can be updated is the footer of an SMTP account. - [Get manual tasks](https://developers.woodpecker.co/docs/manual-tasks/get-manual-tasks.md): Use this endpoint to retrieve a list of all [manual tasks](https://woodpecker.co/help-center/en/articles/5269001) in the authorized account. - [Delete prospects](https://developers.woodpecker.co/docs/prospects/DELETE-prospects.md): :::warning - [Get prospect responses](https://developers.woodpecker.co/docs/prospects/GET-prospect-responses.md): Retrieve a list of responses from a specified prospect. You can get a list of all responses or filter them by campaign. - [Add prospects to a campaign](https://developers.woodpecker.co/docs/prospects/POST-add-prospects-campaign.md): :::warning - [Add prospects to database](https://developers.woodpecker.co/docs/prospects/POST-add-prospects-list.md): :::warning - [Update prospects in database](https://developers.woodpecker.co/docs/prospects/POST-update-prospect-list.md): :::warning - [Update prospects in a campaign](https://developers.woodpecker.co/docs/prospects/POST-update-prospects-campaign.md): :::warning - [Get prospects in campaign](https://developers.woodpecker.co/docs/prospects/get-prospects-campaign.md): :::warning - [Get a list of prospects](https://developers.woodpecker.co/docs/prospects/get-prospects.md): :::warning - [Search for prospects](https://developers.woodpecker.co/docs/prospects/get-search-prospects.md): :::warning - [Prospects](https://developers.woodpecker.co/docs/prospects.md): The `/prospects` endpoints allows you to manage the prospects stored in your database. You can fetch, add, and update prospects. Each prospect has ... - [Complete statistics for each level of campaign](https://developers.woodpecker.co/docs/reports/Complete-statistics.md): This report provides an overview of campaign statistics, including the number of contacted prospects, response rate, bounce rate, interest levels, ... - [General statistics per campaign](https://developers.woodpecker.co/docs/reports/General-statistics.md): This report provides an overview of campaign statistics, including the number of contacted prospects, response rate, bounce rate, interest levels, ... - [Open rate per campaign](https://developers.woodpecker.co/docs/reports/Open-rate.md): message sent on this date has this many opens. - [Number of messages sent from each level in campaigns](https://developers.woodpecker.co/docs/reports/Sent-messages.md): This report focuses on the number of emails sent from your campaigns. It provides a breakdown of emails sent per campaign, day, path, step, and ver... - [Reports](https://developers.woodpecker.co/docs/reports.md): To get an in-depth look into your campaigns' performance, you can generate one of the predefined reports. - [Get a list of users](https://developers.woodpecker.co/docs/users/get-users.md): Retrieve a list of active users in your account. Only confirmed and active accounts will be included. - [Delete domain](https://developers.woodpecker.co/docs/domains/delete-domain.md): Request deletion of an existing Woodpecker domain. Domain lookup is case-insensitive. The domain must belong to the account, must have `is_ready: t... - [Delete domain mailbox](https://developers.woodpecker.co/docs/domains/delete-mailbox.md): Request deletion of an existing mailbox from a domain. Domain and mailbox lookups are case-insensitive. The mailbox must belong to the account, mus... - [Domains](https://developers.woodpecker.co/docs/domains.md): The `/domains` API lets you **purchase domains and mailboxes that are preconfigured for cold emailing** and ready to use in Woodpecker. You can als... - [Search domain availability](https://developers.woodpecker.co/docs/domains/get-domain-availability.md): Search for available domain suggestions by phrase. The response includes available domain proposals and their prices. Use this endpoint when you wa... - [Get domain mailbox](https://developers.woodpecker.co/docs/domains/get-domain-mailbox.md): Retrieve details of a single mailbox under a purchased domain, including general mailbox information, credentials, and IMAP/SMTP settings. To get a... - [List domain mailboxes](https://developers.woodpecker.co/docs/domains/get-domain-mailboxes.md): Retrieve active mailboxes for a purchased domain, including basic mailbox information. For credentials and connection settings, use the [get domain... - [Get domain details](https://developers.woodpecker.co/docs/domains/get-domain.md): Retrieve details for a single purchased domain, including owner data, forwarding settings, readiness status, and mailbox summary. To retrieve all p... - [List domains](https://developers.woodpecker.co/docs/domains/get-domains.md): Retrieve all purchased domains that belong to your account, including their status, expiration date, mailbox count, and other basic information. To... - [Get domain owner](https://developers.woodpecker.co/docs/domains/get-owner.md): Retrieve the domain owner details saved for the account. These details are required before ordering domains and are used to register purchased doma... - [Get domain providers](https://developers.woodpecker.co/docs/domains/get-providers.md): Retrieve providers available for domain and mailbox orders. The response includes the mailbox price for each provider in the account currency. - [Set domain email forwarding](https://developers.woodpecker.co/docs/domains/patch-email-forwarding.md): Set the forwarding email address for an existing domain. All emails sent to mailboxes under the domain will be automatically forwarded to the selec... - [Update mailbox profile picture](https://developers.woodpecker.co/docs/domains/patch-mailbox-profile-picture.md): Add or update the profile picture for an existing mailbox. This helps recipients recognize the sender more easily. Currently, this feature is suppo... - [Set domain redirect URL](https://developers.woodpecker.co/docs/domains/patch-redirect-url.md): Set the redirect URL for an existing domain where visitors will be redirected when they open your domain. You can set it only after the domain is r... - [Check domain availability](https://developers.woodpecker.co/docs/domains/post-domain-availability.md): Check availability for a specific list of domains with a selected provider. The response includes each domain's availability status and price. Use ... - [Order domains](https://developers.woodpecker.co/docs/domains/post-order-domains.md): Order domains and mailboxes that are preconfigured for cold emailing and ready to use in Woodpecker. [Creating a domain owner](/docs/domains/post-o... - [Order domain mailboxes](https://developers.woodpecker.co/docs/domains/post-order-mailboxes.md): Order mailboxes for domains you already purchased in Woodpecker. - [Save domain owner](https://developers.woodpecker.co/docs/domains/post-owner.md): Create or update the domain owner details for the account. A domain owner is required before you can [order domains](post-order-domains.mdx) to reg... - [Agency APIs](https://developers.woodpecker.co/docs/agency-api.md): Woodpecker API provides a set of endpoints for Agency users to manage multiple client accounts within a single Woodpecker account. - [Authentication](https://developers.woodpecker.co/docs/agency-api/authentication-agency.md): Woodpecker API follows a unified authentication mechanism across all endpoints, but when managing multiple accounts, you need to consider the compa... - [Blacklisting](https://developers.woodpecker.co/docs/agency-api/blacklisting.md): Managing a do-not-contact list at the agency level is essential for maintaining a strong sender reputation across all client accounts. Agencies can... - [Delete domains from the agency blacklist](https://developers.woodpecker.co/docs/agency-api/blacklisting/delete-blacklist-domain.md): Remove specific domains from the agency blacklist. Removing a domain from the list doesn't change the status of a prospects if it was previously se... - [Delete emails from the agency blacklist](https://developers.woodpecker.co/docs/agency-api/blacklisting/DELETE-blacklist-email.md): Remove specific emails from the agency blacklist. Removing an email from the list doesn't change the status of a prospects if it was previously set... - [Get blacklisted domains](https://developers.woodpecker.co/docs/agency-api/blacklisting/GET-blacklist-domain.md): Retrieve a list of domains blacklisted in your agency. You can use the `domain_filter` parameter to check whether specific domains are included in ... - [Get blacklisted emails](https://developers.woodpecker.co/docs/agency-api/blacklisting/GET-blacklist-email.md): Retrieve a list of emails blacklisted in your agency. You can use the `email_filter` parameter to check whether specific emails are included in the... - [Blacklist domains](https://developers.woodpecker.co/docs/agency-api/blacklisting/POST-blacklist-domain.md): Add domains to the agency blacklist. Blacklisting a domain does not immediately change the status of existing prospects. Instead, it prevents all c... - [Blacklist emails](https://developers.woodpecker.co/docs/agency-api/blacklisting/POST-blacklist-email.md): Add emails to the agency blacklist. Blacklisting an email does not immediately change the status of existing prospects. Instead, it prevents all cu... - [Get a company's API keys](https://developers.woodpecker.co/docs/agency-api/companies/GET-companies-API-keys.md): Retrieve a paginated list of API keys associated with a specific company. The response will include only the keys created by the requesting user. - [Get list of email accounts assigned to the client](https://developers.woodpecker.co/docs/agency-api/companies/GET-companies-email-accounts.md): This endpoint returns list of the email accounts linked to the client. By using this feature you can `GET` information including - [Get a list of company users](https://developers.woodpecker.co/docs/agency-api/companies/GET-companies-users.md): Retrieve details of users under a specific company, including their ID, name, email, roles, and guest permissions. - [Get companies](https://developers.woodpecker.co/docs/agency-api/companies/GET-companies.md): Retrieve a list of companies managed by your agency, including their ID, name, owner's name, status (active or inactive), number of running campai... - [Create an API key for a company](https://developers.woodpecker.co/docs/agency-api/companies/POST-companies-API-keys.md): This endpoint allows you to generate a new API key for the specified company, which can be used to authenticate API requests. The response contains... - [Delete client's prospects](https://developers.woodpecker.co/docs/agency-api/companies/POST-companies-delete.md): Remove prospects from a specific company within your agency account. - [Invite guests to company](https://developers.woodpecker.co/docs/agency-api/companies/POST-companies-invite-guest.md): This endpoint allows you to invite new guests to a company or resend invitations to those who haven't accepted yet. To modify permissions for alrea... - [Create companies](https://developers.woodpecker.co/docs/agency-api/companies/POST-companies.md): Create new client accounts under your agency account, each with its own prospect database, campaigns, and team access. - [Update guest permissions](https://developers.woodpecker.co/docs/agency-api/companies/PUT-companies-guests-permissions.md): This feature allows you to modify the permissions associated with a particular guest, such as granting access to certain areas or resources. - [Companies](https://developers.woodpecker.co/docs/agency-api/companies.md): The `/companies` endpoint allows you to manage the companies under your agency account. - [Get deliverability statistics](https://developers.woodpecker.co/docs/agency-api/deliverability/GET-deliverability.md): This endpoint provides key campaign metrics, including the total number of emails sent, delivered, opened, replied to, and bounced within a specifi... - [Connect LinkedIn account](https://developers.woodpecker.co/docs/agency-api/linkedin/POST-connect-linkedin.md): Create a LinkedIn account within the company and returns the account ID together with an authorization URL. The user must open the URL to authentic... - [Generate connection link](https://developers.woodpecker.co/docs/agency-api/linkedin/POST-li-connect-link.md): Generates a new authorization URL for an existing LinkedIn account. The user must open the link to authenticate with LinkedIn or reconnect the acco... - [Connecting LinkedIn accounts](https://developers.woodpecker.co/docs/agency-api/linkedin.md): The `/linkedin_accounts` endpoints allow you to create and reconnect LinkedIn accounts associated with companies within your agency. - [Subscribe to a webhook](https://developers.woodpecker.co/docs/webhooks/POST-subscribe-webhook.md): :::warning - [Unsubscribe from a webhook](https://developers.woodpecker.co/docs/webhooks/POST-unsubscribe-webhook.md): :::warning - [Campaign completed](https://developers.woodpecker.co/docs/webhooks/campaign-completed.md): This event is triggered whenever a campaign under your account has completed. This means it has contacted all available prospects, and there are no... - [Campaign paused by Bounce Shield](https://developers.woodpecker.co/docs/webhooks/campaign-paused-by-bounce-shield.md): This event is triggered whenever [Bounce Shield](https://woodpecker.co/help-center/en/articles/15228700) automatically pauses a running campaign be... - [Campaign email sent](https://developers.woodpecker.co/docs/webhooks/campaign-sent.md): This event is triggered whenever a campaign email is sent to a prospect. - [Prospect opened an email](https://developers.woodpecker.co/docs/webhooks/email-opened.md): This event is triggered whenever a prospect opens a tracked email within your campaign. - [Follow-up after autoreply](https://developers.woodpecker.co/docs/webhooks/followup-after-autoreply.md): This event is triggered whenever you schedule the earliest date for the follow-up to be sent after receiving an autoresponse. - [Get webhook subscriptions](https://developers.woodpecker.co/docs/webhooks/get-webhooks.md): Retrieve a list of all subscribed webhooks for the authenticated account. Each webhook consists of a `target_url` and `event` - [Prospect clicked on a link](https://developers.woodpecker.co/docs/webhooks/link-clicked.md): This event is triggered whenever a prospect clicks on a tracked link within your email. Note that link tracking must be enabled in the campaign ste... - [LinkedIn account connected](https://developers.woodpecker.co/docs/webhooks/linkedin-account-connected.md): This event is triggered when a LinkedIn account is successfully connected to Woodpecker. - [LinkedIn account disconnected](https://developers.woodpecker.co/docs/webhooks/linkedin-account-disconnected.md): This event is triggered when a LinkedIn account is disconnected from Woodpecker. - [Prospect autoreplied](https://developers.woodpecker.co/docs/webhooks/prospect-autoreplied.md): This event is triggered whenever a prospect's response is detected or when their status is manually updated to `RESPONDED.` If a prospect who is al... - [Prospect blacklisted](https://developers.woodpecker.co/docs/webhooks/prospect-blacklisted.md): This event is triggered whenever a prospect's status is changed to `BLACKLIST`. This applies to all actions, for example manual blacklisting, secon... - [Prospect bounced](https://developers.woodpecker.co/docs/webhooks/prospect-bounced.md): This event is triggered whenever a prospect's status is changed to `BOUNCED`. - [Prospect interested](https://developers.woodpecker.co/docs/webhooks/prospect-interested.md): This event is triggered whenever a prospect's interest level is updated to `INTERESTED`. It can be initiated by either a manual change or an AI-cla... - [Prospect invalid](https://developers.woodpecker.co/docs/webhooks/prospect-invalid.md): This event is triggered whenever a prospect's status is changed to `INVALID`. Both manually as well as during the built-in email validation. - [LinkedIn connection request accepted](https://developers.woodpecker.co/docs/webhooks/prospect-li-cr-accepted.md): This event is triggered when a prospect accepts a LinkedIn connection request sent through Woodpecker LinkedIn automation. - [LinkedIn direct message sent](https://developers.woodpecker.co/docs/webhooks/prospect-li-dm-sent.md): This event is triggered when Woodpecker sends a LinkedIn direct message through LinkedIn automation. The payload contains prospect data as well as ... - [Prospect maybe later](https://developers.woodpecker.co/docs/webhooks/prospect-maybe-later.md): This event is triggered whenever a prospect's interest level is updated to `MAYBE_LATER`. It can be initiated by either a manual change or an AI-cl... - [Prospect nonresponsive](https://developers.woodpecker.co/docs/webhooks/prospect-non-responsive.md): This event is triggered when a prospect's campaign status changes to `NON_RESPONSIVE`. This indicates that the prospect has gone through all campai... - [Prospect not interested](https://developers.woodpecker.co/docs/webhooks/prospect-not-interested.md): This event is triggered whenever a prospect's interest level is updated to `NOT_INTERESTED`. It can be initiated by either a manual change or an AI... - [Prospect opt-out](https://developers.woodpecker.co/docs/webhooks/prospect-opt-out.md): This event is triggered whenever a prospect's status is changed to `OPT_OUT`. This applies to the prospect using the unsubscribe link or manually c... - [Prospect replied](https://developers.woodpecker.co/docs/webhooks/prospect-replied.md): This event is triggered whenever a prospect's response is detected or when their status is manually updated to `RESPONDED`. If a prospect who is al... - [Prospect saved](https://developers.woodpecker.co/docs/webhooks/prospect-saved.md): This event is triggered whenever a new prospect is added to your database or there's an update of an existing one. The triggers for this event incl... - [Secondary response](https://developers.woodpecker.co/docs/webhooks/secondary-replied.md): This event is triggered whenever a [secondary response](https://woodpecker.co/help-center/en/articles/5241870) is detected. `prospect` object conta... - [Task created](https://developers.woodpecker.co/docs/webhooks/task-created.md): This event is triggered whenever a manual task for a prospect is created. - [Task done](https://developers.woodpecker.co/docs/webhooks/task-done.md): This event is triggered whenever a manual task for a prospect is marked as done. - [Task ignored](https://developers.woodpecker.co/docs/webhooks/task_ignored.md): This event is triggered whenever a manual task for a prospect is marked as ignored. - [Webhooks](https://developers.woodpecker.co/docs/webhooks.md): You can utilize webhooks to get notified about events related to your prospects and campaigns. You will receive a notification when a prospect repl... - [Available tools](https://developers.woodpecker.co/docs/mcp/available-tools.md): Create a Woodpecker email campaign with one email step and minimal configuration. - [Connect Claude to the Woodpecker MCP server](https://developers.woodpecker.co/docs/mcp/connect-claude.md): Connect Woodpecker to Claude in just a few steps - no local server or API key required. Once connected, you can chat with Claude to manage your cam... - [Examples & tips](https://developers.woodpecker.co/docs/mcp/examples-tips.md): Use these example prompts and tips to manage campaigns, add prospects, and review performance through the Woodpecker MCP server. Before using a pro... - [Woodpecker MCP Server](https://developers.woodpecker.co/docs/mcp.md): The Woodpecker MCP (Model Context Protocol) server lets AI agents interact directly with your Woodpecker account. - [Run the Woodpecker MCP server locally](https://developers.woodpecker.co/docs/mcp/run-locally.md): Run the Woodpecker MCP server with Docker if you want to host it yourself, connect it to an MCP client that supports `stdio`, or use it with client... - [Woodpecker CLI](https://developers.woodpecker.co/docs/cli.md): The Woodpecker CLI brings your Woodpecker workspace to the terminal. It is useful when you want to check something quickly, automate a repeated tas... - [Examples & tips](https://developers.woodpecker.co/docs/cli/examples-tips.md): The CLI is useful when you want Woodpecker data close to where you already work: in a terminal, a script, or an AI coding agent. You can check camp... - [Installation](https://developers.woodpecker.co/docs/cli/installation.md): Install the Woodpecker CLI from npm, verify that it runs, and configure authentication before making API calls. For regular use, the global install...