Email Campaigns Webhook Automation
Webhooks provides a real-time data transmission between different products and apps.
A webhook delivers data from one application to another about events and actions that have taken place.
Many platforms out there support webhooks to transmit data and integrate with other apps and those who don't can be easily automated with tools such as Zapier and Make.
Email campaigns support incoming webhooks so you can automatically add new contacts to your testimonial request campaign once a user completes an action.
For example - a user completed checkout and submitted an order, you can send a webhook to Shapo and add them to your testimonial request email campaign.
Select campaigns from the left menu and click on the desired campaign.
In the campaign details page you will see the webhook URL associated with your campaign:
Copy the webhook URL and input it in the platform of your choice.
Once a contact is added to a campaign via a webhook, the campaign email is immediately sent to the user.
Shapo campaign webhooks accept POST requests with a JSON payload.
The payload must include an email field of the desired contact.
If your campaign contains personalization fields/parameters, the webhook payload must contain that data as well.
e.g. if you used a {{name}} personalization field, the webhook payload must contain a name field.
Here's an example for a webhook request to add a contact using a webhook:
In some cases webhooks may respond with an error:
If there's no email field in the payload or an invalid email is used
If the email is already in the campaign
If the workspace is not on the Pro plan
If you don't have any more contacts left on your monthly plan
If the payload is missing a personalization field
A webhook delivers data from one application to another about events and actions that have taken place.
Many platforms out there support webhooks to transmit data and integrate with other apps and those who don't can be easily automated with tools such as Zapier and Make.
Email campaigns support incoming webhooks so you can automatically add new contacts to your testimonial request campaign once a user completes an action.
For example - a user completed checkout and submitted an order, you can send a webhook to Shapo and add them to your testimonial request email campaign.
How to use Shapo Campaign Webhooks?
Select campaigns from the left menu and click on the desired campaign.
In the campaign details page you will see the webhook URL associated with your campaign:
Copy the webhook URL and input it in the platform of your choice.
Once a contact is added to a campaign via a webhook, the campaign email is immediately sent to the user.
Webhook Payload Requirements
Shapo campaign webhooks accept POST requests with a JSON payload.
The payload must include an email field of the desired contact.
If your campaign contains personalization fields/parameters, the webhook payload must contain that data as well.
e.g. if you used a {{name}} personalization field, the webhook payload must contain a name field.
Here's an example for a webhook request to add a contact using a webhook:
POST https://api.shapo.io/campaign/webhook/4d073606-2dd7-4a4d-b9d7-c6462de3f0b4
POST body (JSON):
{
"email": "customer@email.com",
"name": "John Mcclane"
}Webhook Errors
In some cases webhooks may respond with an error:
If there's no email field in the payload or an invalid email is used
If the email is already in the campaign
If the workspace is not on the Pro plan
If you don't have any more contacts left on your monthly plan
If the payload is missing a personalization field
Updated on: 29/01/2024