Skip to content

[WEB-4261] Open Hubspot chat when conversation Meta tag is present #2528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2025

Conversation

matt423
Copy link
Member

@matt423 matt423 commented Apr 14, 2025

Description

When the conversation meta tag is present, open the hubspot chat with the relevant query parameter.

Testing

Use review app to complete journey below. On the last page visit, the chat should popup

Platform
Chat Setup

Copilot Summary

This pull request introduces new functionality to the Hubspot integration by adding the ability to open the chat widget based on a meta tag in the document. The changes include updates to the test cases, global window interface, and the main Hubspot function.

New functionality for Hubspot integration:

  • src/external-scripts/hubspot.ts: Added openFromMetaTag function to check for a meta tag and open the chat widget if it exists. Updated the hubspot function to register openFromMetaTag as a callback for hsConversationsOnReady.
  • src/external-scripts/hubspot.ts: Extended the global Window interface to include hsConversationsSettings and hsConversationsOnReady properties.

Test cases for new functionality:

  • src/external-scripts/hubspot.test.ts: Added test cases for openFromMetaTag to verify the chat widget opens when the meta tag is present, does not open when the meta tag is absent, and correctly sets the URL query parameter based on the meta tag content.

Checklist

Copy link

coderabbitai bot commented Apr 14, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@matt423 matt423 temporarily deployed to ably-docs-web-4261-hubs-g99kvr April 14, 2025 12:11 Inactive
@matt423 matt423 force-pushed the web-4261-hubspot-meta-tag branch from 73697c8 to d8d7643 Compare April 14, 2025 12:15
@matt423 matt423 temporarily deployed to ably-docs-web-4261-hubs-g99kvr April 14, 2025 12:15 Inactive
@matt423 matt423 temporarily deployed to ably-docs-web-4261-hubs-g99kvr April 14, 2025 12:35 Inactive
@matt423 matt423 marked this pull request as ready for review April 14, 2025 12:43
@matt423 matt423 requested a review from a team April 14, 2025 12:43
@jamiehenson
Copy link
Member

Forgive me for being a dumbo tester but what journey are you talking about with the review links provided? Should I be expecting something to pop up on one of them?

@matt423
Copy link
Member Author

matt423 commented Apr 14, 2025

@jamiehenson When you visit both of them, you'll see the Hubspot conversation popup. Left more thorough review notes on the Voltaire PR

@matt423 matt423 requested a review from kennethkalmer April 16, 2025 08:47
Copy link
Member

@kennethkalmer kennethkalmer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice one @matt423 👏

The meta tag is populated from the website proxy. When it's present, open the Hubspot chat.
Hubspot will be configured to only open if agents are online, which is why no additional status checks are needed.
@matt423 matt423 force-pushed the web-4261-hubspot-meta-tag branch from d8d7643 to d643236 Compare April 16, 2025 09:08
@matt423 matt423 temporarily deployed to ably-docs-web-4261-hubs-g99kvr April 16, 2025 09:08 Inactive
@matt423 matt423 merged commit eed28a1 into main Apr 16, 2025
5 checks passed
@matt423 matt423 deleted the web-4261-hubspot-meta-tag branch April 16, 2025 09:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants