API Overview
The RESTful API provides developers with the necessary tools to integrate with external applications or websites.
Some common use cases are:
- Creating Users & Lists
- Creating Templates using content from a CMS
- Automating Campaign delivery
- Keeping email addresses & data in synch with other applications e.g. CRM
- Triggering Workflows to automate sending of decision based emails.
- Downloading Campaign delivery and engagement data for internal use.
Endpoint Explorer
The first step to getting started with the API is to generate API keys. Admin rights are required to perform this action within the account settings screen. Once API keys have been generated HTTP GET and POST requests can be made to all API endpoints.
API Identifiers
"API Identifiers" are displayed throughout the UI and are essentially references that allow you to manage features such as Lists, Templates, Campaigns and Workflows through the API.
Once API keys have been generated the UI will display an "API Identifier" field within the edit screen of any piece of content where it is relevant.
Developers Zone
The Developers Zone provides detailed reporting for API requests and responses and is useful for setting up integration projects and investigating communication issues.
Click here to find out more about the Developers Zone.
Webhooks
Webhooks provide the ability to send email delivery and User engagement data packets in real-time to other applications.
Click here to find out more about how to configure Webhooks.