Implementing client-side callbacks

The developer framework is currently in BETA

This framework is in beta. Please submit a Github issue if you encounter any problems or have a question.

There a number of behaviors that are triggered in response to key events associated with using the Unified CRM extension. These callbacks are invoked with the intent of performing one of the following browser functions:

• Open a tab corresponding to an incoming call's associated contact record
• Open a tab corresponding to the activity record associated with a phone call
• Perform any garbage collection when a user logs out of a CRM

Call-pop

"Call-pop" refers to the action of opening the relevant contact record in the associated CRM in response to an incoming call. The typical function of this callback is to formulate the URL to a contact record stored in the CRM, and open a new browser tab to that URL.

• Triggering event: call received
• Callback input parameters:
  • hostname = The hostname of the CRM that will form the base of the formulated URL
  • incomingCallContactInfo = a hash summarizing the associated contact record

Incoming call contact info

The following hash is sent to the callback as an input parameter.

{
  id: '1234829292',
  name: 'John Doe',
  phone: '+11234567890'
}

Example callback

Sample adapterPipedrive adapter

function openContactPage(hostname, incomingCallContactInfo) {
    //-----------------------------------
    //------TODO: Open contact page------
    //-----------------------------------

    console.log(`hostname: ${hostname}`)
    console.log(`contact info: ${incomingCallContactInfo}`)
    // window.open(`https://${hostname}?contactId=${incomingCallContactInfo.id}`);
}

function openContactPage(hostname, incomingCallContactInfo){
    window.open(`https://${hostname}/person/${incomingCallContactInfo.id}`);
}

Opening call log page

When the canOpenLogPage config option is set to true in the config file, then a new menu item will appear in the more menu for each call in the call history page. When a user clicks on This menu item labeled "Open log page," this callback is executed. The callback's function is to formulate a URL to the call log page, and open a new browser tab to that URL.

• Triggering event: user clicks "Open call log" in the more menu of the phone's call history tab
• Callback input parameters:
  • hostname = The hostname of the CRM that will form the base of the formulated URL
  • logId = <Unique log ID of record in CRM>

Example callback

Sample adapterPipedrive adapter

// Case: If CRM platform support log page, use this function to open log page window
// To use this, please also set config.json "canOpenLogPage" to true
// function openLogPage({ hostname, logId }) {
//     //-------------------------------
//     //------TODO: Open log page------
//     //-------------------------------

//     // window.open(`https://${hostname}/activities/${logId}`);
// }
// exports.openLogPage = openLogPage;

function openLogPage({ hostname, logId }) {
    window.open(`https://${hostname}/activities/${logId}`);
}

Deauthorizing users

When a user logs out of a CRM via the Unified CRM extension, then this callback is executed -- giving developers an opportunity to perform any garbage collection or other clean up activities.

• Triggering event: user clicks "Logout" on the settings page for the CRM
• Callback input parameters: none

Sample adapterPipedrive adapterBullhorn adapter

async function onUnauthorize() {

}

async function onUnauthorize(){

}

async function onUnauthorize(){
    await chrome.storage.local.remove('crm_extension_bullhornUsername');
    await chrome.storage.local.remove('crm_extension_bullhorn_user_urls');
}