API Reference

Webhooks

Mailivery Notify You About events that happened In the application. Currently, Webhooks are only supported for API actions.

Knock knock

who?

web.

web who? ohh webhook

📘

Webhook Destination

You can set webhook destination in embeddable form settings from the Admin panel.

Please Note that If you have specified different owner at the time of campaign creation. Webhook notification will be send to his/her webhook endpoints.

Here is a List of all the events currently supported

1. Campaign Pending

This webhook is triggered only for Microsoft email accounts created from the embed form.


{
  "type": "campaign.pending",
  "action": "pending",
  "account": {
    "campaign_id": 216,
    "first_name": "Suraj",
    "lalst_name": "Jadhav",
    "email": "[email protected]",
    "provider_type": "office",
    "tags": [
      "worthcoding",
      "97694201"
    ],
    "meta": "meta=4dd49f4f84e4d6945e3bc6d14812004e&tags=97694201,%20worthcoding"
  }
}

2. Campaign Created

This Webhook is Triggered after the campaign (Except) has been created in the Mailivery

{
  "type": "campaign.created",
  "action": "created",
  "account": {
    "campaign_id": 203,
    "first_name": "Josh",
    "last_name": "Cohen",
    "email": "[email protected]",
    "provider_type": "gmail",
    "tags": [
      "worthcoding",
      "97694201"
    ],
    "meta": null
  }
}

3. Campaign Updated

This Webhook is Triggered after the campaign has been updated in the Mailivery. This webhook will also trigger after the Microsoft account has been reconnected.

{
  "type": "campaign.updated",
  "action": "updated",
  "account": {
    "campaign_id": 198,
    "first_name": "Suraj",
    "last_name": "Jadhav",
    "email": "[email protected]",
    "meta": ""
  }
}

4. Campaign Deleted

This webhook is triggered after the campaign has been successfully deleted from the Mailivery.

{
  "type": "campaign.deleted",
  "action": "deleted",
  "account": {
    "campaign_id": 209,
    "first_name": "Josh",
    "last_name": "Cohen",
    "email": "[email protected]",
    "type": "smtp",
    "meta": null
  }
}

5. Campaign Connection Problem

This webhook is triggered after the campaign is problematic.

{
  "type": "campaign.connection.problematic",
  "action": "system_notification",
  "reason": "Smtp Connection Error",
  "account": {
    "id": 218,
    "first_name": "Josh Cohen",
    "last_name": "Cohen",
    "email": "[email protected]",
    "provider_type": "smtp",
    "tags": [
      "mailivery",
      "worthcoding"
    ],
    "meta": null
  }
}

Here is a List of all the Reasons we pass in Webhook If an Active campaign has been paused due to a connection Problem. We will keep Updating List with Proper error messages.

List Of All Reasons