A webhook lets an app pass information to other apps in near real-time. This could mean notifying a private application developed just for you, or a way to notify another 3rd party application that accepts POST requests.

In MuxEmail, webhooks are used to send data from your account into another system or database that has an API (application programming interface) that can listen for webhooks (eg. Zapier). They are event driven and allow you to update 3rd party applications with contact and campaign activity as they happen.

You may want to use webhooks to keep contacts' records in sync with an external database or application, or maintain an external unsubscribe list.

How to create a webhook

  • Navigate to the accounts section in your MuxEmail account
  • Switch to the 'MuxEmail Tokens' tab and scroll to view the Webhooks section
  • Click on "Add new webhook"
  • Insert your callback URL and select the events when this webhook should post data. And hit 'Save'.

How webhook data is received

  • The data you receive will be sent as a POST parameter to your URL.

When can you trigger a webhook POST

MuxEmail currently POSTs data during these events:

  • When there is new subscriber ("type": "subscribes")
{
"type": "subscribes",
"fired_at": "2021-03-10T11:04:21.764Z",
"data": {
"email": "[email protected]",
"fname": "Amit",
"mname": "",
"lname": "Hazra",
"phone": "",
"gender": "male",
"dob": "1998-02-22T18:30:00.000Z",
"tags": [
"Teacher",
"Coffee Lover"
],
"status": "Subscribed",
"softBounceCount": 0,
"addressLine1": "",
"addressLine2": "",
"city": "Kolkata",
"state": "West Bengal",
"postalCode": 743348,
"country": "IN",
"destination": "Karanjali",
"landmark": "Kolkata"
}
}

  • When a contact's data (including tags) is updated ("type": "profileupdate")
{
"type": "profileupdate",
"fired_at": "2021-03-10T11:07:51.103Z",
"data": {
"email": "[email protected]",
"mname": "Kumer",
"phone": "909-307-9136",
"tags": [
"Teacher",
"TestBroadcast",
"Coffee Lover"
]
}
}

  • When a contact unsubscribes ("type": "unsubscribed")
{
"type": "unsubscribed",
"fired_at": "2021-03-10T11:09:53.918Z",
"data": {
"email": "[email protected]",
"status": "Unsubscribed"
}
}

It's a good practice to Delete the unused webhooks in your account.

Did this answer your question?