Webhooks

Mailivery notifies you about events that happen in the application. Currently, webhooks are only supported for API actions.

📘

Webhook destination

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

Note: if you specified a different owner at the time of campaign creation, the webhook notification will be sent to their webhook endpoints.

Here is a list of all the events currently supported.

1. Mailbox (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",
    "last_name": "Jadhav",
    "email": "[email protected]",
    "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 Mailivery.

JSON

{
  "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. Mailbox (campaign) Updated

This webhook is triggered after a mailbox has been updated in Mailivery. It also fires after a Microsoft account has been reconnected.

JSON

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

4. Mailbox (campaign) Deleted

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

JSON

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

5. Mailbox (campaign) Connection Problem

This webhook is triggered when an active mailbox encounters a connection problem and is paused.

JSON

{
  "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 passed in the webhook payload when an active mailbox is paused due to a connection problem. We update this list as new error messages are added.

List of all reasons