Sendy API Essential Guide

What type of API does Sendy provide?

Sendy API Type

• Sendy's API is based on simple HTTP POST requests.
• The documentation does not mention REST, GraphQL, or SOAP specifically for Sendy's own API.

Key Points to Consider

• Sendy provides API examples and code snippets for integrating with their API using HTTP POST.
• There are third-party libraries and integrations available for working with Sendy's API in various languages like .NET, Ruby, etc.
• Sendy offers webhook functionality for integrating with other services.

Best Practices

• When working with Sendy's API, use HTTP POST requests as specified in their documentation.
• Utilize the provided code examples and third-party libraries to simplify integration.
• Consider using webhooks for real-time integrations with other services.

While Sendy's API is not explicitly REST, GraphQL, or SOAP, it follows a simple HTTP-based approach that allows for programmatic integration with websites and applications. The API's simplicity may make it easier to work with for basic integration needs compared to more complex API architectures.

Does the Sendy API have webhooks?

Official Webhook Support

The official Sendy API does not appear to have built-in webhook functionality. There is no mention of native webhook support or events you can subscribe to in the official API documentation.

Third-Party Webhook Solutions

While not officially supported, there are some third-party solutions that provide webhook-like functionality for Sendy:

1. A project called "Sendy Webhooks" allows setting up webhooks when using services other than Amazon SES with Sendy.

2. There are integrations that use webhooks to connect Sendy with other platforms, like Eventbrite and LiveAgent.

3. The "Trigger Webhook" feature in Sendy's Rules allows triggering a webhook when certain events occur, like when an autoresponder message is sent.

Webhook Usage Examples

Some examples of how webhooks are used with Sendy include:

• Triggering actions when an autoresponder sequence finishes
• Subscribing users to a new list after completing a sequence
• Handling bounces and complaints from email service providers like Elastic Email

Implementing Webhooks

To use webhooks with Sendy, you generally need to:

1. Create a script that performs the desired action (e.g., subscribing to a new list)
2. Host this script at a URL accessible to Sendy
3. Configure Sendy to call this URL when certain events occur

Third-Party Integration Platforms

Services like Zapier offer integrations between Sendy and webhooks, allowing you to create automated workflows without coding.

In summary, while Sendy does not have official webhook support in its API, there are workarounds and third-party solutions that provide webhook-like functionality for various use cases. The "Trigger Webhook" feature in Sendy's Rules is the closest to native webhook support.

Rate Limits and other limitations

Based on the search results, here are the key points regarding the API rate limits of the Sendy API:

Rate Limiting

The Sendy API has rate limiting in place, with the following restrictions [1]:

• 100 requests per minute
• 1 request per second

Sending Quota Limits

While not directly related to API rate limits, it's important to note that Sendy's sending capabilities are tied to Amazon SES (Simple Email Service) limits [3][5]:

• New SES accounts typically start with a default limit of 10,000 emails per 24-hour period.
• Users can request extended access to increase this limit.
• Some users have reported receiving increased limits (e.g., 50,000 per day) after requesting extended access.

Handling Large Lists

For users with large mailing lists that exceed their SES limits, some strategies include [5]:

1. Splitting large lists into smaller ones (e.g., 50,000 subscribers or less).
2. Scheduling sends over multiple days to stay within daily limits.
3. Requesting higher sending limits from Amazon SES.

Key Considerations

• Sendy does not allow sending to lists larger than the user's current SES limit [3].
• The sending and 'schedule' buttons are disabled if the selected list(s) exceed the user's SES quota [3].
• Users can request extended access from Amazon to increase their sending limits [3][5].

It's important to note that while these points relate to sending limits, they are not strictly API rate limits. The actual API rate limits are the 100 requests per minute and 1 request per second mentioned earlier.

Best Practices

1. Request extended access from Amazon SES if you need higher sending limits.
2. Consider splitting large lists into smaller segments if necessary.
3. Plan your API usage to stay within the 100 requests per minute and 1 request per second limits.
4. Monitor your sending quotas and adjust your strategies accordingly.

Remember that these limits may change over time, so it's always a good idea to check the official Sendy documentation for the most up-to-date information on API rate limits and sending quotas.

Latest API Version

Based on the search results provided, here is the answer to your question:

The most recent version of the Sendy API is 6.1.1.

Key points to consider:

• Sendy's API is based on simple HTTP POST [1].
• Some APIs may require the latest version of Sendy, which is currently version 6.1.1 [1].
• The Sendy API documentation is available, but the search results don't provide specific version information for the API itself [3].

Additional information:

• The latest version of the sendypy Python module (which interfaces with the Sendy API) is 5.2.5, released on Nov 15, 2021 [4].
• Sendy has had multiple version updates over time, including versions 1.x, 2.x, 3.x, 4.x, and 5.x, with various features and improvements added in each version [2].

It's important to note that while the Sendy software itself is at version 6.1.1, the API version may not necessarily match the software version. However, the search results don't provide specific information about a separate API versioning system. Therefore, it's reasonable to assume that the most recent version of the Sendy API corresponds to the latest software version, which is 6.1.1.

How to get a Sendy developer account and API Keys?

To get a developer account for Sendy and create an API integration, here are the key steps:

1. Purchase and install Sendy on your own server. Sendy is a self-hosted email newsletter application, so you need to buy a license and set it up yourself.

2. Once Sendy is installed, you'll have access to the API documentation and capabilities.

3. The Sendy API is based on simple HTTP POST requests. You can integrate it programmatically with your website or application.

4. To use the API, you'll need:

   • Your Sendy installation URL
   • Your API key (found in Settings when logged in as the main Sendy user)
   • List IDs for the mailing lists you want to interact with

5. There's no separate "developer account" - you can start using the API once Sendy is set up on your server.

6. For iOS integration specifically:

   • Use HTTP POST requests in your iOS app code to interact with the Sendy API endpoints
   • Make sure to properly format the API requests according to the documentation
   • Test thoroughly, as some users have reported issues with email validation

7. Sendy provides example API scripts you can reference, though they may not be iOS-specific.

8. Consider using a third-party Sendy API wrapper library for iOS/Swift if available, to simplify the integration.

The key is having Sendy properly installed and configured on your own server first. Then you can start making API calls to it from your iOS application.

What can you do with the Sendy API?

Based on the search results provided, here is a list of data models that can be interacted with using the Sendy API, along with what is possible for each:

Subscribers

• Add or update a subscriber to a list [3]
• Subscribe users to one or multiple lists [1]
• Unsubscribe users from lists (implied)

Lists

• Create subscriber widgets for lists [1]
• Get subscriber count for a list [1]
• Add customers to lists based on products purchased [1]

Campaigns

• Create and send email campaigns [1]
• Get information about sent email campaigns [1]

Custom Fields

• Add or update custom field data for subscribers [2]
• Overwrite existing custom field values [2]

Products (for e-commerce integrations)

• Associate products with Sendy lists [1]
• Add customers to lists based on products purchased [1]

Brands/Companies

• Likely ability to manage multiple brands or companies within Sendy (implied)

Key points to consider:

• The Sendy API is based on simple HTTP POST requests [1]
• Some APIs may require the latest version of Sendy [1]
• There is currently no direct way to retrieve existing subscriber data through the API [2]
• The API allows for integration with various third-party services and platforms [1]

Best practices:

• Use the provided subscribe form HTML code for easy list integration [1]
• Leverage integrations with platforms like Zapier, Make, and Pabbly Connect for extended functionality [1]
• Consider using available libraries and plugins for specific programming languages or platforms (e.g., Sendy.Net for .NET, WordPress plugins) [1]

It's important to note that while the Sendy API offers various capabilities, some functionalities like retrieving existing subscriber data are not currently supported directly through the API [2]. The available operations seem to focus primarily on adding, updating, and managing subscribers and campaigns.