The BigMailer Developer Hub

Welcome to the BigMailer developer hub. You'll find comprehensive guides and documentation to help you start working with BigMailer as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Webhook Event Types

Unsubscribe

An unsubscribe event is sent when a contact modifies their own subscription status.

{
    "type": "unsubscribe",
    "brand_id": "0da934ea-f96f-4f2f-85dd-0e8ceb9cba0e",
    "unsubscribe": {
        "date": 1579811821,
        "campaign_id": "9ebe0652-6364-4688-897c-cf2655f988e8",
        "contact_id": "f36999a4-7fc0-4a03-868c-21fad154db1b",
        "email": "[email protected]",
        "unsubscribe_all": false,
        "unsubscribe_ids": ["48e7b6d6-4c2f-4819-9294-41aaed22f837", "aa3f3b4c-862e-4a00-aadb-0d82e4def938"]
    }
}
  • brand_id (string) - ID of the brand.
  • unsubscribe (object)
    • date (number) - A UNIX timestamp (in seconds) indicating when the contact submitted the form.
    • campaign_id (string) - ID of the campaign.
    • contact_id (string) - ID of the contact.
    • email (string) - Contact's email address.
    • unsubscribe_all (string) - true if the contact unsubscribed from all future campaigns, false otherwise.
    • unsubscribe_ids (array of strings) - An array of message type IDs the contact unsubscribed from.

Bounce

A bounce event is sent when an email sent to a contact bounces.

{
    "type": "bounce",
    "brand_id": "0da934ea-f96f-4f2f-85dd-0e8ceb9cba0e",
    "bounce": {
        "date": 1579811821,
        "campaign_id": "9ebe0652-6364-4688-897c-cf2655f988e8",
        "contact_id": "f36999a4-7fc0-4a03-868c-21fad154db1b",
        "email": "[email protected]",
        "type": "hard"
    }
}
  • brand_id (string) - ID of the brand.
  • bounce (object)
    • date (number) - A UNIX timestamp (in seconds) indicating when the email bounced.
    • campaign_id (string) - ID of the campaign.
    • contact_id (string) - ID of the contact.
    • email (string) - Contact's email address.
    • type (string) - hard if the bounce was a hard (permanent) bounce, soft if the bounce was a soft (transient) bounce.

Complaint

A bounce event is sent when a contact complains about receiving email from you.

{
    "type": "complaint",
    "brand_id": "0da934ea-f96f-4f2f-85dd-0e8ceb9cba0e",
    "complaint": {
        "date": 1579811821,
        "campaign_id": "9ebe0652-6364-4688-897c-cf2655f988e8",
        "contact_id": "f36999a4-7fc0-4a03-868c-21fad154db1b",
        "email": "[email protected]"
    }
}
  • brand_id (string) - ID of the brand.
  • complaint (object)
    • date (number) - A UNIX timestamp (in seconds) indicating when the complaint happened.
    • campaign_id (string) - ID of the campaign.
    • contact_id (string) - ID of the contact.
    • email (string) - Contact's email address.

Updated 10 months ago

Webhook Event Types


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.