Configuring Custom JavaScript Integration

Overview

Custom JavaScript integrations allow administrators to extend event functionality by injecting approved JavaScript snippets that respond to selected event data. This feature enables controlled customisation while maintaining platform stability and security. Administrators can create, manage, activate, and restrict these integrations by associating them with specific event fields and teams.

Step-by-Step Approach

1. Create a New Custom JavaScript Integration

• On the General Dashboard, go to Integrations.
• Click + Integration.
• Select the type as JavaScript and the sub type as Custom.
• Enter a name for the integration to help identify its purpose.
• Click Save to proceed.

2. Add a JavaScript Snippet

• In the integration form, locate the JavaScript Snippet field.
• Paste the JavaScript code into the editor.
• Ensure the snippet follows the required and agreed format defined by the platform:
  • Only supported functions and variables are allowed.
  • Arbitrary or unsupported JavaScript will be rejected.
• Save the changes.

3. Select Applicable Event Fields

• In the Event Fields section of the integration form, open the Select Field dropdown.
• Choose the event fields that should be exposed to the JavaScript integration.
• The selected fields will appear in the list below the dropdown.
• Save the integration to apply the selected fields.

4. Remove Selected Event Fields

• Locate the event fields listed under the Selected Event Fields section.
• Click the Trash icon next to the field you want to delete.
• The field is immediately removed from the integration.
• Save the changes to confirm.

5. Activate or Deactivate the Custom JavaScript Integration

• After saving the integration, use the Status toggle to control availability:
  • Activated: The JavaScript integration is enabled and in use.
  • Deactivated: The integration remains saved but is not executed.
• Changes take effect immediately after toggling.

6. Remove the Custom JavaScript Integration

• From the Custom JavaScript Integrations listing, locate the integration you want to delete.
• Click Delete.
• Confirm the deletion when prompted.
  • This action permanently removes the integration and its configuration.

7. Access the Teams Listing

• Open the Custom JavaScript integration you want to manage.
• Click Teams tab.

8. Select Teams from the “Select Teams” Pop-up

• In the Select Teams pop-up, browse or search for the required teams.
• Select one or more teams to associate with the integration.
• Click Select to include the selected teams.
• The teams will appear in the Teams listing.

9. Remove Teams from the Listing

• In the Teams listing, locate the team you want to remove.
• Click the More Options (:) icon next to the team name.
• Select Remove Teams.