Webhooks

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

📘

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. Mailboxes (campaign) Pending

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

JSON

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

2. Mailbox (campaign) Created

This webhook is Triggered after the mailbox (campaign) has been created in the Mailivery

JSON

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

3. Mailbox (campaign) Updated

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

JSON

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

4. Mailbox (campaign) Deleted

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

JSON

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

5. Mailbox (campaign) Connection Problem

This webhook is triggered after a mailbox is problematic.

JSON

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

Here is a List of all the Reasons we pass in Webhook if an active mailbox/campaign has been paused due to a connection problem. We will keep updating this list with proper error messages.

List Of All Reasons