BombBomb Webhooks

With Bombbomb's webhooks integration, you can have BombBomb alert your servers in real-time to events in your BombBomb account. Keep reading to learn more! 

Step 1: In your BombBomb account, hover over your name in the upper right corner and click "Integrations." 

Step 2: Search for "webhooks" and click on the webhooks icon.

Step 3: Click "Add New Webhook." 

Step 4: Once you've added your webhook, click "Send Test Webhook" to send a test. Once you click this, it will open a screen on the right, showing it's been sent. Now, as events occur, such as email sends and email opens, you'll show those events reflected in this screen. 

BombBomb's webhooks are sent as application/json encoded HTTP POST requests to a url of your choosing.

Enabling Webhooks:

 

Manually

In your account, go to your Profile > Integrations > Webhooks. Enter the url you would like BombBomb to POST events to in the box labeled Webhook Url, then click Add.

You can then press the Send Test Webhook button to immediately send yourself a simple test webhook.

Via BombBomb's API 

BombBomb offers three API methods to work with webhooks. These are all user-authenticated API calls as defined in our API documentation.

GetWebHooks

   [No Parameters]

AddWebHook

   Requires parameter: hookUrl 

DeleteWebHook

   Requires parameter: hookId

Available Webhooks

TestWebhook

{
  "eventName":"TestWebhook",
  "eventTimestamp":"14347322876914",
  "payload":{
    "hello":"world",
    "time":1434732287
}}

ContactAddedToList

{
  "eventName": "ContactAddedToList",
  "eventTimestamp": "14347350473261",
  "payload": {
    "listId": "0cecba16-cb23-433c-a8b5-b5f683b9363d",
    "contacts": [
      {
        "id": "55d48dcd-8f0e-4152-9ab0-14c94a7b531d",
        "email": "[e-mail]"
      }
    ]
  }
}

ContactSuppressed

{
  "eventName": "ContactSuppressed",
  "eventTimestamp": "14347350473261",
  "payload": {
    "contacts": [
      {
        "id": "55d48dcd-8f0e-4152-9ab0-14c94a7b531d",
        "email": "[e-mail]"
      }
    ]
  }
}

ContactUnsubscribed

{
  "eventName": "ContactUnsubscribed",
  "eventTimestamp": "14347350473261",
  "payload": {
    "listId": "0cecba16-cb23-433c-a8b5-b5f683b9363d",
    "contacts": [
      {
        "id": "55d48dcd-8f0e-4152-9ab0-14c94a7b531d",
        "email": "[e-mail]"
      }
    ]
  }
}

ContactUpdated

{
  "eventName": "ContactUpdated",
  "eventTimestamp": "14347350473261",
  "payload": {
    "contactId": "55d48dcd-8f0e-4152-9ab0-14c94a7b531d"
  }
}

EmailSent

{
  "eventName": "EmailSent",
  "eventTimestamp": "14347326849077",
  "payload": {
    "jobId": "3759b4d6-89c2-6eef-505a-8608588fc333",
    "emailId": "6d65b3f2-a993-31a2-ac0d-a2b208087d36",
    "contacts": [
      {
        "id": "c325ff5a-bf91-98b0-d87a-4e66737310e5",
        "email": "[e-mail]"
      }
    ]
  }
}

EmailOpened

{
  "eventName": "EmailOpened",
  "eventTimestamp": "14347327037672",
  "payload": {
    "emailId": "338a9ee7-a726-c4b6-f640-f162459105d6",
    "jobId": "3759b4d6-89c2-6eef-505a-8608588fc333",
    "contacts": [
      {
        "id": "c325ff5a-bf91-98b0-d87a-4e66737310e5",
        "email": "[e-mail]"
      }
    ]
  }
}

EmailClicked

{
  "eventName": "EmailClicked",
  "eventTimestamp": "14347327193179",
  "payload": {
    "jobId": "3759b4d6-89c2-6eef-505a-8608588fc333",
    "emailId": "338a9ee7-a726-c4b6-f640-f162459105d6",
    "linkUrl": "http:\/\/www.bombbomb.com ",
    "emailAddress": "[e-mail]",
    "contacts": [
      {
        "id": "c325ff5a-bf91-98b0-d87a-4e66737310e5",
        "email": "[e-mail]"
      }
    ]
  }
}

VideoReady

{
  "eventName": "VideoReady",
  "eventTimestamp": "14347326824487",
  "payload": {
    "videoId": "c0e31794-b675-a5bd-65b1-550cbc6e8d85"
  }
}

VideoPlayed

Sometimes the jobId and contacts array will be null if the video is played outside the context of an email (ie: embedded on a webpage). 

{
  "eventName": "VideoPlayed",
  "eventTimestamp": "14347327102364",
  "payload": {
    "videoId": "c0e31794-b675-a5bd-65b1-550cbc6e8d85",
    "jobId": "3759b4d6-89c2-6eef-505a-8608588fc333",
    "contacts": [
      {
        "id": "c325ff5a-bf91-98b0-d87a-4e66737310e5",
        "email": "[e-mail]"
      }
    ]
  }
}

FlaggedForAbuse

{
  "eventName":"FlaggedForAbuse",
  "eventTimestamp":"14347322876914",
  "payload": null
}

FormSubmitted

FormSubmitted has a variable payload dependant on the form that is submitted. The fields included on the form will come through in the payload, along with the __form_id field.

{
  "eventName": "FormSubmitted",
  "eventTimestamp": "14347357518243",
  "payload": {
    "__form_id": "b9d80181-45ec-48a4-b8c0-daffc39b1cf7",
    "first_name": "Friendly",
    "last_name": "Contactman",
    "email": "[e-mail]",
    "phone_number": "3215551212"
  }
}