Based on the search results provided, EmailOctopus appears to have a REST API. The available information strongly suggests that EmailOctopus uses a REST API, which is the most common and practical choice for their type of service.
The key points are:
The search results do not explicitly state what type of API EmailOctopus uses.
However, the "API Documentation" for EmailOctopus, which typically refers to a REST API.
REST APIs are very common and widely used for web services and applications.
The EmailOctopus API documentation page does not mention SOAP, GraphQL, or other API types, which further suggests it is likely a REST API.
REST APIs are well-suited for web and mobile applications, which aligns with EmailOctopus's email marketing service.
To confirm this definitively, you may want to check the API documentation for specific mentions of REST endpoints or HTTP methods, look for JSON or XML response formats, or contact EmailOctopus support directly for confirmation.
Yes, the official EmailOctopus API does support webhooks.
You can subscribe to the following event types via webhooks:
To set up webhooks:
The webhook payload includes details like:
EmailOctopus provides a way to validate webhook requests using an HMAC-SHA256 signature.
In summary, EmailOctopus offers comprehensive webhook support for tracking various contact-related events, with options to customize which events you receive and validate incoming requests.
Based on the search results provided, here are the API Rate Limits for the EmailOctopus API:
You can make up to 10 requests per second to the EmailOctopus API.
If you exceed this limit, you will receive a '429 Too Many Requests' HTTP status code.
Your connection will be blocked for up to a minute if you exceed the rate limit.
These limits are in place to ensure a high-quality service for all users.
If you need to exceed these limits, EmailOctopus suggests considering the following alternatives:
Plan your API usage to stay within the 10 requests per second limit.
Implement proper error handling in your code to deal with potential 429 status codes.
For large data operations, consider using the recommended alternatives like the import process or webhooks.
If you consistently need higher limits, you may want to contact EmailOctopus support to discuss your specific needs.
By adhering to these rate limits and following the suggested alternatives for high-volume operations, you can ensure smooth integration with the EmailOctopus API while maintaining good service quality for all users.
The most recent version of the EmailOctopus API is 1.6.
Key points to consider:
The API version 1.6 is consistently used in the API endpoints shown in the search results [2][3][5].
The EmailOctopus Add-On for Gravity Forms was updated to use API version 1.6 in its release 1.3 [4].
The API documentation provided in the search results consistently refers to version 1.6 for various API operations, such as updating lists, getting list details, and creating contacts [2][3][5].
Code example:
Here's an example of how to use the latest API version (1.6) to create a contact in a list:
import requests headers = { 'Content-Type': 'application/json', } data = '''{ "api_key": "00000000-0000-0000-0000-000000000000", "email_address": "[email protected]", "fields": { "FirstName": "Joe", "LastName": "Bloggs", "Birthday": "2020-12-20" }, "tags": ["vip"], "status": "SUBSCRIBED" }''' response = requests.post('https://emailoctopus.com/api/1.6/lists/00000000-0000-0000-0000-000000000000/contacts', headers=headers, data=data)
Best practices:
Always use the latest API version (currently 1.6) to ensure access to the most up-to-date features and improvements.
Include your API key in all requests to authenticate your access to the EmailOctopus API.
Use appropriate HTTP methods (GET, POST, PUT, etc.) as specified in the API documentation for different operations.
Handle potential errors by checking the response status code and error messages returned by the API.
To get a developer account for EmailOctopus and create an API integration, follow these steps:
Sign up for an EmailOctopus account: If you don't already have an EmailOctopus account, you'll need to sign up for one at emailoctopus.com.
Log in to your EmailOctopus account: Once you have an account, log in to access your dashboard.
Navigate to the API documentation page: Go to the API documentation page at https://emailoctopus.com/api-documentation.
Generate an API key: On the API documentation page, you'll find an option to create an API key. Click on the "Create key" button.
Name your API key: You'll be prompted to provide a name for your API key. This helps you identify different keys if you create multiple ones.
Create the API key: After naming your key, click the "Create" button to generate your API key.
Save your API key: Once created, your API key will be displayed. Make sure to copy and save this key securely, as it will only be shown once. You can also download the key as a CSV file.
Based on the provided search results, here are the key data models you can interact with using the EmailOctopus API, along with what is possible for each:
Content-Type: application/json header when making JSON requests.This overview covers the main data models and operations available through the EmailOctopus API, allowing developers to interact with campaigns, lists, contacts, and list fields programmatically.
