Handle UPDATE_ASSOCIATIONS_FAILED message

demos/demo-react-ts/src/hooks/useCti.ts

@@ -158,7 +158,7 @@ class CallingExtensionsWrapper implements CallingExtensionsContract {
 }
 
 export const useCti = (
-  initializeCallingStateForExistingCall: (incomingNumber: string) => void,
+  initializeCallingStateForExistingCall: (incomingNumber: string) => void
 ) => {
   const [phoneNumber, setPhoneNumber] = useState("");
   const [engagementId, setEngagementId] = useState<number | null>(null);
@@ -187,7 +187,7 @@ export const useCti = (
           const incomingNumber =
             window.localStorage.getItem(INCOMING_NUMBER_KEY);
           const incomingContactName = window.localStorage.getItem(
-            INCOMING_CONTACT_NAME_KEY,
+            INCOMING_CONTACT_NAME_KEY
           );
           if (engagementId && incomingNumber && incomingContactName) {
             setEngagementId(engagementId);
@@ -244,7 +244,7 @@ export const useCti = (
             // save info in localstorage so that it can retrieved on redirect
             window.localStorage.setItem(
               INCOMING_NUMBER_KEY,
-              cti.incomingNumber,
+              cti.incomingNumber
             );
             window.localStorage.setItem(INCOMING_CONTACT_NAME_KEY, name);
             cti.navigateToRecord({
@@ -287,6 +287,12 @@ export const useCti = (
         onSetWidgetUrlFailed: (data: any, _rawEvent: any) => {
           /** HubSpot was unable to change the widget iframe src URL. */
         },
+        onUpdateAssociationsFailed: (data: any, _rawEvent: any) => {
+          /** HubSpot was unable to update associations for the desired record page. */
+        },
+        onFailed: (data: any, _rawEvent: any) => {
+          /** All failed events from HubSpot */
+        },
       },
     });
   }, []);

src/CallingExtensions.js

@@ -213,6 +213,7 @@ class CallingExtensions {
     const { eventHandlers } = this.options;
 
     let handler;
+
     if (type in messageHandlerNames) {
       const name = messageHandlerNames[type];
       if (name in eventHandlers) {
@@ -231,6 +232,13 @@ class CallingExtensions {
       });
     }
 
+    const isFailedEvent = String(type).endsWith("_FAILED");
+
+    if (isFailedEvent) {
+      const failedHandler = eventHandlers[messageType.FAILED];
+      failedHandler(data, event);
+    }
+
     handler = handler || eventHandlers.defaultEventHandler;
     if (handler) {
       handler(data, event);

src/Constants.js

@@ -38,6 +38,7 @@ const hostToThirdPartyEvents = {
   INITIATE_CALL_ID_FAILED: "INITIATE_CALL_ID_FAILED",
   INITIATE_CALL_ID_SUCCEEDED: "INITIATE_CALL_ID_SUCCEEDED",
   NAVIGATE_TO_RECORD_FAILED: "NAVIGATE_TO_RECORD_FAILED",
+  UPDATE_ASSOCIATIONS_FAILED: "UPDATE_ASSOCIATIONS_FAILED",
   PUBLISH_TO_CHANNEL_FAILED: "PUBLISH_TO_CHANNEL_FAILED",
   PUBLISH_TO_CHANNEL_SUCCEEDED: "PUBLISH_TO_CHANNEL_SUCCEEDED",
   SET_WIDGET_URL_FAILED: "SET_WIDGET_URL_FAILED",
@@ -58,6 +59,7 @@ export const messageType = {
   SYNC_ACK: "SYNC_ACK",
   SYNC: "SYNC",
   UNLOADING: "UNLOADING",
+  FAILED: "FAILED",
 };
 
 /**
@@ -74,6 +76,7 @@ export const messageHandlerNames = {
   [messageType.INITIATE_CALL_ID_FAILED]: "onInitiateCallIdFailed",
   [messageType.INITIATE_CALL_ID_SUCCEEDED]: "onInitiateCallIdSucceeded",
   [messageType.NAVIGATE_TO_RECORD_FAILED]: "onNavigateToRecordFailed",
+  [messageType.UPDATE_ASSOCIATIONS_FAILED]: "onUpdateAssociationsFailed",
   [messageType.PUBLISH_TO_CHANNEL_FAILED]: "onPublishToChannelFailed",
   [messageType.PUBLISH_TO_CHANNEL_SUCCEEDED]: "onPublishToChannelSucceeded",
   [messageType.READY]: "onReady",
@@ -82,6 +85,7 @@ export const messageHandlerNames = {
   [messageType.UPDATE_ENGAGEMENT_FAILED]: "onUpdateEngagementFailed",
   [messageType.UPDATE_ENGAGEMENT_SUCCEEDED]: "onUpdateEngagementSucceeded",
   [messageType.VISIBILITY_CHANGED]: "onVisibilityChanged",
+  [messageType.FAILED]: "onFailed",
 };
 
 export const errorType = {

src/typedefs.js

@@ -16,6 +16,7 @@
  * @property {function} onInitiateCallIdFailed - Called when initiating a call ID fails.
  * @property {function} onInitiateCallIdSucceeded - Called when initiating a call ID succeeds.
  * @property {function} onNavigateToRecordFailed - Called when navigating to a record fails.
+ * @property {function} onUpdateAssociationsFailed - Called when updating associations for a record fails.
  * @property {function} onPublishToChannelFailed - Called when publishing to a channel fails.
  * @property {function} onPublishToChannelSucceeded - Called when publishing to a channel succeeds.
  * @property {function} onReady - Called when HubSpot is ready to receive messages.
@@ -24,6 +25,7 @@
  * @property {function} onUpdateEngagementFailed - Called when updating an engagement fails.
  * @property {function} onUpdateEngagementSucceeded - Called when updating an engagement succeeds.
  * @property {function} onVisibilityChanged - Called when the call widget's visibility changes.
+ * @property {function} onFailed - Called when any of the failed events occurs.
  * @property {function} [defaultEventHandler] - Default event handler to handle unhandled events.
  */