Connecting SparkPost with your Chamaileon account allows you to streamline your email marketing workflow, enabling seamless syncing of email designs and content.
Through this integration, email templates in Chamaileon will be directly linked to a SparkPost template.
Each time the design or content is updated in Chamaileon and the Sync button is pressed, the template will automatically update in SparkPost.
This guide will walk you through the integration process step-by-step, covering everything you need to know to get started.
Prerequisites
Before you begin the process, make sure you have:
An active Chamaileon account with Administrator or Content Manager access.
Access to your SparkPost account with the necessary permissions (e.g., Admin or API access).
A SparkPost API key, which you will generate during the integration setup.
Step-by-Step Integration Setup Process
Step 1: Access Integration Settings in Chamaileon
Log in to your Chamaileon account.
Navigate to the Workspace settings and select the "Integrations" tab.
Choose "SparkPost" from the list of available integrations.
Step 2: Obtain API Key from SparkPost
Log in to your SparkPost account.
Navigate to the "Configuration" menu and select "API Keys."
Generate a new API key and ensure you select the necessary permissions for this integration.
Note: Make sure you have the correct user permissions to create an API key.
Copy the API key and return to Chamaileon.
Step 3: Authorize SparkPost with Chamaileon
In the Chamaileon integration setup for SparkPost, create a new Variation. Each variation serves as a distinct account connection, allowing you to sync emails from one Chamaileon account to multiple SparkPost accounts.
Name the integration variation and click “Auth.”
Enter the API key you obtained from SparkPost to complete the authorization.
Figure 2 - Integration-specific new Variation modal in Chamaileon
Data Sync Details
The integration will sync the following data between Chamaileon and SparkPost:
Subject: The email's subject line.
Preview Text: The preview text displayed in the recipient's inbox.
Template ID: A unique identifier for the email template in SparkPost.
Template Name: The name of the email template.
From Email: The email address that will appear in the "From" field of the recipient's email.
Description: A brief description of the template.
Testing the Integration
To test the integration, try syncing a sample email template from Chamaileon to SparkPost.
Check your SparkPost account to verify that the template has been successfully imported.
When you go back to your Sparkpost dashboard, under ''Content'', and then ''Templates'', you will see the email that you synched.
If the export is successful, you’re all set!
Handling API Limits and Security Considerations
API Limits: SparkPost may impose API call limits. Refer to SparkPost’s documentation to ensure you stay within these limits.
Security: Keep your API key secure and do not share it. If you suspect it has been compromised, regenerate the key in your SparkPost account.
Troubleshooting and Known Limitations
Common Issues:
If the connection fails, double-check that the API key is correctly copied and has the necessary permissions.
Ensure that your SparkPost account has the correct access level for integration.
Known Limitations:
This integration supports syncing only email templates.
Supported file types and character limits depend on SparkPost’s specifications.
Notifications: Chamaileon will notify you in case of integration issues, such as failed syncs or expired API keys.
Disconnecting or Removing the Integration
To safely disconnect or remove the SparkPost integration, go to the “Integrations” section in Chamaileon Workspace settings.
Click on the SparkPost card, select the desired variation, and click the red "Delete Variation" button.
Remember to remove access/authorization/API keys from SparkPost as well.
Sync Email Designs with SparkPost
From the email dashboard, click the "Sync" button in the email's menu.
Choose "SparkPost" from the options list.
Customize your email template's settings, such as the subject line, preview text, template ID, template name, from email, and description before clicking "Sync."
Attention!
Avoid editing the code directly in SparkPost, as its editor might alter the email HTML code, potentially causing size or rendering issues. Use Chamaileon’s visual editor interface for any changes and the Sync button to update the design.
Syncing one template to multiple SparkPost accounts is possible using Integration Variations, so avoid manually copying and pasting HTML.
Conclusion
You have now successfully integrated SparkPost with your Chamaileon account! This integration will enhance your email marketing process by allowing seamless exports and efficient content management. If you have any questions or encounter issues, please refer to our support documentation or contact our support team.