BombBomb makes it easy to build relationships with simple videos. Use this JavaScript API to record a video on your website, email it within a clean, beautiful design, and receive detailed analytics on opens, click and plays. With the free BombBomb app you can receive push notifications and respond right away when someone interacts with your email.

To begin, include the BBCore and jQuery libraries in your html (The latest version is available at https://static.bombbomb.com/js/BBCore.min.js):

<script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/3.4.0/jquery.min.js"></script>
<script type="text/javascript" src="https://static.bombbomb.com/js/BBCore.min.js"></script>

Then instantiate BBCore:

var bb = new BBCore({ accessToken: '<your access token or api key>', onerror: OnInvalidTokenCallback});

Take a look in the examples/ directory to see some example implementation.

Embed a video recorder on your website and record to a BombBomb account without leaving your site.

Create a video recorder and save a recording by calling startVideoRecorder(), specifying a css selector target into which you would like the recorder to appear.

bb.startVideoRecorder({ target: '#recorderDiv'}, function (vidInfo) {
 if (confirm('Is this the take you would like to save?')) {
     bb.saveRecordedVideo('Our video!', vidInfo.videoId, vidInfo.filename, function (data) {
         alert('Your video has been saved!');
     });
 }
});

IMPORTANT NOTE: If you intend to reuse the same BBCore object, it's HIGHLY recommended you call getNewVideoGuid() prior to calling startVideoRecorder. However, it's recommended that you otherwise destroy the BBCore object after the recorder has completed and create a new one.  

Wrap your video in a nicely designed template, add a personal written message if you like, and press send.

To send a video in your default template, use videoQuickSend().

bb.videoQuickSend({
    subject: 'Your Subject Line',
    video_id: vidInfo.videoId, // saved from the earlier call
    email_addresses: '[email protected]',
    mobile_message: "Simple message to include"

}, function (data) {
    alert("You've sent a video! " + data.info);
});

Have your system be notified in real-time as events happen in your customer's BombBomb account. BombBomb's Webhooks make it easy to keep your system up to date.

bb.sendRequest('AddWebHook', {
    hookUrl: '<Your Listener URL>'
});

View your email opens, link clicks and video plays. When you can see how people are interacting with your emails and videos you'll know exactly when to follow up.

Download the free BombBomb app for your iOS or Android device and enable realtime notifications. View contact details or respond from your mobile device with one click.

contacts

BBCore

videoOptions

BBCore : object

responseSuccess(responseObject, jqXHR)

reponseSuccess

responseSuccess : Object

responseObject : Object

OAuthClientCredentials : Object

responseSuccess : function

This callback is displayed as a global member.

requestParameters : object

getClientInteractionOptions : object

customVideoEmailOptions : object

responseSuccess : function

This callback is displayed as a global member.

contactProperties : Object

videoProperties : object

Kind: global class

• contacts
  • .add(contact) ⇒ contacts
  • .find(fieldName, value) ⇒ * | contact

Adds a Contact contact to Contacts collection

Kind: instance method of contacts

Returns the first matched contact from

Kind: instance method of contacts

Kind: global class

• BBCore
  • instance
    • .resumeStoredSession
    • .getServerUrl() ⇒ BBCore.apiServer | * | BBCore.CONFIG.SERVER_API_URL
    • .getRequestUrl() ⇒ string
    • .sendRequest(method, [params], [success], [error])
    • .login(uid, pwd, success)
    • .credentialsSaved() ⇒ boolean
    • .saveCredentials(uid, pwd)
    • .validateSession(onSuccess, onError)
    • .validateAccessToken(onSuccess)
    • .isAuthenticated() ⇒ boolean | *
    • .invalidateSession() ⇒ boolean | *
    • .verifyKey(key, complete)
    • .storeKey(key)
    • .verifyJsonWebToken(key, complete)
    • .storeOAuthTokens(key)
    • .getOAuthPayload() ⇒ string
    • .validateOAuthCode(authCode, onSuccess, onError)
    • .refreshOAuthToken()
    • .storeJsonWebToken(key)
    • .getValidJsonWebTokenAsync(callback)
    • .getLists(success)
    • .createList(listName, success)
    • .getContact(contactId, success)
    • .getListContacts(listId, success)
    • .addContact(contact, success)
    • .bulkAddContacts(opts, success)
    • .updateContact(opts, success)
    • .getImportAddressesByType(opts, success)
    • .addContactImportAddress(opts, success)
    • .getClientRecentInteractions(opts, success)
    • .getEmails(success)
    • .sendCustomVideoEmail(opts, success)
    • .getDrips(opts, success)
    • .getForms(opts, success)
    • .getClientIntegrations(opts, success)
    • .deleteVideo(videoId, success)
    • .videoQuickSend(opts, onSuccess)
    • .getEmbeddedRecorderUrl([options], onComplete)
    • .getVideoRecorder(opts, onComplete)
    • .saveRecordedVideo(title, videoId, videoFilename, success)
    • .saveRecording(options)
  • static
    • .video
      • new video(properties)
    • .contact
      • new contact(properties)
    • .video
      • new video(properties)
    • .CONFIG : Object

DEPRECATED - Use validateSession

Kind: instance property of BBCore

Kind: instance method of BBCore

Returns the fully qualified URL for BB API

Kind: instance method of BBCore

Sends a request to the specified method of the BombBomb API

Kind: instance method of BBCore

Authenticates a user using their Email Address (User Id) and Password

Kind: instance method of BBCore

Returns bool for whether or not a prior authentication is stored locally

Kind: instance method of BBCore

Save credentials to local storage (not recommended)

Kind: instance method of BBCore

Authenticates from previously stored credentials

Kind: instance method of BBCore

Kind: instance method of BBCore

Returns bool for authentication state

Kind: instance method of BBCore

Invalidates and clears the active session, similar to logout

Kind: instance method of BBCore

Validates the given key

Kind: instance method of BBCore

Stores the give session key, typically used so a session can be resumed later on.

Kind: instance method of BBCore

Validates the given key

Kind: instance method of BBCore

Stores the OAuth Token for API calls

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Stores the give session key, typically used so a session can be resumed later on.

Kind: instance method of BBCore

Attempts to always return a valid JWT which makes an async verification request

Kind: instance method of BBCore

Retrieves Contact Lists

Kind: instance method of BBCore

Creates a Contact List and returns the Guid

Kind: instance method of BBCore

Retrieves a Contact

Kind: instance method of BBCore

Retrieves Contacts from a Contact List

Kind: instance method of BBCore

Adds a Contact to a Contact List

Kind: instance method of BBCore

Adds a batch of Contacts

Kind: instance method of BBCore

Kind: instance method of BBCore

Retrieves an Import Address by a Type

Kind: instance method of BBCore

Retrieves an Import Address by a Type

Kind: instance method of BBCore

Retrieves a list of re

Kind: instance method of BBCore

Retrieves a list of Emails from the current authenticated session

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Deletes a Video

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

{Object} BBCore.videos

Kind: static class of BBCore

stuff

Kind: static class of BBCore
Properties

Contact Object

BBCore.video

Kind: static class of BBCore
Properties

Kind: static constant of BBCore
Properties

Kind: global class
Properties

Kind: global namespace

• BBCore : object
  • instance
    • .resumeStoredSession
    • .getServerUrl() ⇒ BBCore.apiServer | * | BBCore.CONFIG.SERVER_API_URL
    • .getRequestUrl() ⇒ string
    • .sendRequest(method, [params], [success], [error])
    • .login(uid, pwd, success)
    • .credentialsSaved() ⇒ boolean
    • .saveCredentials(uid, pwd)
    • .validateSession(onSuccess, onError)
    • .validateAccessToken(onSuccess)
    • .isAuthenticated() ⇒ boolean | *
    • .invalidateSession() ⇒ boolean | *
    • .verifyKey(key, complete)
    • .storeKey(key)
    • .verifyJsonWebToken(key, complete)
    • .storeOAuthTokens(key)
    • .getOAuthPayload() ⇒ string
    • .validateOAuthCode(authCode, onSuccess, onError)
    • .refreshOAuthToken()
    • .storeJsonWebToken(key)
    • .getValidJsonWebTokenAsync(callback)
    • .getLists(success)
    • .createList(listName, success)
    • .getContact(contactId, success)
    • .getListContacts(listId, success)
    • .addContact(contact, success)
    • .bulkAddContacts(opts, success)
    • .updateContact(opts, success)
    • .getImportAddressesByType(opts, success)
    • .addContactImportAddress(opts, success)
    • .getClientRecentInteractions(opts, success)
    • .getEmails(success)
    • .sendCustomVideoEmail(opts, success)
    • .getDrips(opts, success)
    • .getForms(opts, success)
    • .getClientIntegrations(opts, success)
    • .deleteVideo(videoId, success)
    • .videoQuickSend(opts, onSuccess)
    • .getEmbeddedRecorderUrl([options], onComplete)
    • .getVideoRecorder(opts, onComplete)
    • .saveRecordedVideo(title, videoId, videoFilename, success)
    • .saveRecording(options)
  • static
    • .video
      • new video(properties)
    • .contact
      • new contact(properties)
    • .video
      • new video(properties)
    • .CONFIG : Object

DEPRECATED - Use validateSession

Kind: instance property of BBCore

Kind: instance method of BBCore

Returns the fully qualified URL for BB API

Kind: instance method of BBCore

Sends a request to the specified method of the BombBomb API

Kind: instance method of BBCore

Authenticates a user using their Email Address (User Id) and Password

Kind: instance method of BBCore

Returns bool for whether or not a prior authentication is stored locally

Kind: instance method of BBCore

Save credentials to local storage (not recommended)

Kind: instance method of BBCore

Authenticates from previously stored credentials

Kind: instance method of BBCore

Kind: instance method of BBCore

Returns bool for authentication state

Kind: instance method of BBCore

Invalidates and clears the active session, similar to logout

Kind: instance method of BBCore

Validates the given key

Kind: instance method of BBCore

Stores the give session key, typically used so a session can be resumed later on.

Kind: instance method of BBCore

Validates the given key

Kind: instance method of BBCore

Stores the OAuth Token for API calls

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Stores the give session key, typically used so a session can be resumed later on.

Kind: instance method of BBCore

Attempts to always return a valid JWT which makes an async verification request

Kind: instance method of BBCore

Retrieves Contact Lists

Kind: instance method of BBCore

Creates a Contact List and returns the Guid

Kind: instance method of BBCore

Retrieves a Contact

Kind: instance method of BBCore

Retrieves Contacts from a Contact List

Kind: instance method of BBCore

Adds a Contact to a Contact List

Kind: instance method of BBCore

Adds a batch of Contacts

Kind: instance method of BBCore

Kind: instance method of BBCore

Retrieves an Import Address by a Type

Kind: instance method of BBCore

Retrieves an Import Address by a Type

Kind: instance method of BBCore

Retrieves a list of re

Kind: instance method of BBCore

Retrieves a list of Emails from the current authenticated session

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Deletes a Video

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

Kind: instance method of BBCore

{Object} BBCore.videos

Kind: static class of BBCore

stuff

Kind: static class of BBCore
Properties

Contact Object

BBCore.video

Kind: static class of BBCore
Properties

Kind: static constant of BBCore
Properties

reponseSuccess

Kind: global function

Kind: global typedef
Properties

Kind: global typedef
Properties

Kind: global typedef
Properties

This callback is displayed as a global member.

Kind: global typedef

Kind: global typedef
Properties

Kind: global typedef
Properties

Kind: global typedef
Properties

This callback is displayed as a global member.

Kind: global typedef

Kind: global typedef
Properties

Kind: global typedef
Properties