Woodpecker.co API Essential Guide

What type of API does Woodpecker.co provide?

Based on the search results, Woodpecker.co has a REST API. Specifically, the documentation states:

API Type

Woodpecker.co uses a REST API. The documentation states:

"This documentation helps you implement REST Woodpecker API 2.0, which:

• uses a JSON format,
• is stateless,
• requires API key for authorization."

Key Features

• Uses JSON format
• Stateless
• Requires API key for authentication
• Has rate limits (1 request processed at a time, 15 second queue time limit, max 6 queued requests)

Versions

• There are currently two versions of the Woodpecker API - 1.0 and 2.0
• Version 2.0 is under ongoing development with new functionalities being added

Documentation

Detailed documentation is available covering:

• Authentication
• Managing prospects
• Browsing campaigns
• Webhooks
• Error codes
• Agency management

Does the Woodpecker.co API have webhooks?

Availability of Webhooks

Yes, the official Woodpecker.co API does have webhooks available.

Types of Events

You can subscribe to the following types of events via webhooks:

• Events related to prospects
• Email opens
• Email replies
• Email clicks

How to Subscribe

To subscribe to Woodpecker webhooks:

1. Send a POST request to https://api.woodpecker.co/rest/v1/webhooks/subscribe

2. Include the following in the request body:

{
  "target_url": "https://your-endpoint.com/webhook",
  "event": "<event_name>"
}

3. Replace <event_name> with the specific event you want to subscribe to.

Key Points

• You need to subscribe to each event separately.
• The API Key is part of an "API Key and Integrations" add-on that needs to be enabled.
• There are rate limits for webhooks, though the specific limits are not provided.
• You can also unsubscribe from webhooks if needed.

Best Practices

• Use a unique URL for each webhook subscription to easily manage them.
• Handle potential errors, like 409 Conflict if you try to subscribe to an event you're already subscribed to.
• Consider implementing proper authentication and validation on your webhook endpoint to ensure security.

In summary, the Woodpecker.co API offers webhook functionality, allowing you to receive real-time notifications for various prospect-related events, which can be useful for integrating Woodpecker.co with other systems or for building custom workflows based on prospect interactions.

Rate Limits and other limitations

Here are the key points about the API Rate Limits for the Woodpecker.co API:

Number of API Calls

• There is an unlimited number of API calls allowed per month

Concurrent Requests

• Only 1 request can be processed at a time

Queued Requests

• The time limit for queued requests is 15 seconds
• The maximum number of queued API requests is 6
• Any requests above 6 will be immediately dropped

Webhook Subscriptions

• You can subscribe to the same event up to 3 times per account

Key Considerations

• The API uses JSON format and requires an API key for authorization
• There are currently two versions of the API - 1.0 and 2.0
• You can use both versions simultaneously

Best Practices

• Be mindful of the queuing limits when making multiple rapid requests
• Use webhooks to receive real-time notifications rather than polling frequently
• Unsubscribe from webhooks you no longer need to stay under the 3 per event limit

In summary, while Woodpecker allows unlimited API calls per month, there are some restrictions on concurrent and queued requests to prevent overloading their systems. Proper use of webhooks and adhering to the queuing limits will help ensure smooth API integration.

Latest API Version

Based on the search results provided, the most recent version of the Woodpecker.co API is version 2.0. Here are the key points to consider:

API Version 2.0

• Woodpecker API 2.0 is the latest version of the API.
• It uses a JSON format and is stateless.
• API 2.0 requires an API key for authorization.

Key Points

• There are currently two versions of Woodpecker API – 1.0 and 2.0.
• API 2.0 is under ongoing development, with new functionalities being constantly added.
• Users can use both versions (1.0 and 2.0) simultaneously.

API Features

• There is an unlimited number of API calls per month.
• Only 1 request can be processed at a time.
• The time limit for queued requests is 15 seconds, with a maximum of 6 queued API requests.

Additional Information

• To use the API, you need to generate an API key, which is part of the "API Key and Integrations" add-on.
• Detailed documentation for both API 1.0 and API 2.0 is available on the Woodpecker website.

It's important to note that while API 2.0 is the most recent version, both versions are still supported and can be used. For the most up-to-date and comprehensive information, it's recommended to refer to the official Woodpecker API documentation.

How to get a Woodpecker.co developer account and API Keys?

To get a developer account for Woodpecker.co and create an API integration, you need to follow these steps:

1. Get the API Key and Integrations Add-on

The API Key is part of an add-on called "API Key and Integrations" that you need to purchase for your Woodpecker account. This add-on will allow you to integrate Woodpecker with other tools.

2. Generate an API Key

Once you have the add-on, you can generate an API key:

1. Log in to your Woodpecker account
2. Go to Settings > Integrations
3. Click on "Generate API Key"
4. Copy and securely store your API key

3. Use the API Documentation

Woodpecker provides detailed API documentation to help you create integrations:

• There are two versions of the Woodpecker API: 1.0 and 2.0
• You can find the API reference for version 2.0
• The documentation includes information on authentication, managing prospects, browsing campaigns, and more

Key Points to Consider

• There is no limit on the number of API calls per month
• Only one request can be processed at a time
• The time limit for queued requests is 15 seconds, with a maximum of 6 queued requests
• Woodpecker uses JSON format and requires the API key for authorization

Best Practices

• Securely store your API key and never share it publicly
• Use the appropriate API version (1.0 or 2.0) based on your needs
• Follow the rate limits and queuing guidelines to ensure smooth integration

If you're interested in building a native integration with Woodpecker, you can fill out a form to become an API partner. This can provide additional benefits such as joint marketing initiatives and unique brand exposure.

For any questions or support during the integration process, you can contact Woodpecker's support team at [email protected].

What can you do with the Woodpecker.co API?

Based on the search results provided, here are the key data models you can interact with using the Woodpecker.co API:

• Prospects

• Detailed description of managing prospects via API [1]

• Campaigns

• Browsing campaigns and checking their stats [1]

• Webhooks/Event notifications

• List of available webhooks for notifications [1]

• Companies (for Agency accounts)

• Company management via API for agency accounts [1]

Key points for each data model:

Prospects: • Add, update, and manage prospect data • Likely includes fields like name, email, company, etc.

Campaigns: • Browse existing campaigns • Check campaign statistics and performance metrics

Webhooks/Event notifications: • Set up notifications for specific events • Likely includes things like email opens, replies, etc.

Companies (Agency accounts): • Manage multiple client companies • Access client account data and campaigns

Additional capabilities:

• Authentication and access management [2] • Rate limits and request queuing [2] • Integration with email providers like Google Mail [3]

The API uses JSON format and requires an API key for authorization [2]. While the exact endpoints aren't specified, the API allows programmatic access to core Woodpecker.co functionality around prospect and campaign management.