How to Configure a Custom JavaScript Callback for a Handoff Action

Summary

This article details how to set up a 'Callback' handoff action using custom JavaScript. This allows you to execute specific functions or trigger events in your application when a user selects the handoff option.

When to Use This

This guide is for when you want to create a handoff action that performs a custom function, such as opening a specific application, triggering a third-party widget, or passing data to another system. This is ideal for creating a deeply integrated user support experience.

Step-by-Step Instructions

1. In the Pick your actions step of creating a handoff action, select the Callback option.
2. The Callback configuration section will expand.
3. Provide a descriptive name for the action in the Action Name field, such as "Run callback."
4. Locate the Callback Code editor, which contains boilerplate code and comments explaining the context object.
5. Inside the function(context) block, remove the placeholder comment // Your custom code here.
6. Write your custom JavaScript code. For example, to open a specific application, you might use window.openMyApp();.
7. Review the code to ensure it is correct.
8. Click the Add button to save the callback action.

screen-recording-2025-11-06T02-10-54-745Z.webm 3000x1610

Common Questions (FAQs)

Q: What is the context object in the callback function? A: The context object contains useful information about the user's session, such as their query, the AI's response, conversation ID, and other metadata, which you can use in your custom code.

Q: Can I use external libraries in my callback code? A: The capabilities of the callback code depend on the environment in which it is executed. Generally, you should stick to standard JavaScript and functions available in the global scope of the page where the script is running.

Q: Do I need to be a developer to use the callback action? A: Yes, a basic understanding of JavaScript is required to effectively write and debug the custom code for the callback action.

Troubleshooting Tips

• Issue: The custom JavaScript code is not executing.
  • Solution: Double-check your code for any syntax errors. Open your browser's developer console (usually by pressing F12) to look for any error messages that appear when the callback is triggered. Ensure your function names are spelled correctly.
• Issue: The 'Add' button is disabled.
  • Solution: Make sure you have filled out the Action Name field, as it is a required field for saving the callback action.