[Hyperengage Actions] - Added Documentation for New Destination #5539

zhadier39 · 2023-10-16T12:27:49Z

Proposed changes

Added documentation for the Hyperengage Actions Destination.

Merge timing

ASAP

joe-ayoub-segment

Note for docs team reviewer:

This Integration has 3 Actions, one to handle each of track(), identify() and group calls.

joe-ayoub-segment · 2023-10-16T12:40:15Z

src/connections/destinations/catalog/hyperengage/index.md

+
+Hyperengage (Actions) offers several advantages:
+
+- **Seamless Data Mapping.** Hyperengage streamlines the process of syncing your user and account data. By linking your account, identify, track, and group calls with user or account data will be processed by Hyperengage, bypassing the need for manual API integrations.


Can we reword the sentence starting with "By linking your account..." please? I feel that it could be better explained. We're only syncing Segment identify, track and group calls, not 'account' calls.

Hey @joe-ayoub-segment ,
Thank you for your feedback, I've rephrased the sentence to sound less ambigious.

forstisabella

a couple of changes and we'll be good to go 🚀

forstisabella · 2023-10-16T21:03:18Z

src/connections/destinations/catalog/hyperengage/index.md

+<!-- In the section below, explain the value of this actions-based destination. If you don't have a classic version of the destination, remove this section. -->
+[Hyperengage](https://hyperengage.io/){:target="_blank"} tracks thousands of data points to trigger smart alerts on hidden opportunities when the accounts are ready for upsell, or likely to churn. By integrating product data into your GTM strategy, our platform empowers CSM’s and AE’s to achieve up to 5x higher lead conversion and better retention and adoption.
+
+## Benefits of Hyperengage (Actions)


hi @tcgilbert - do we typically include this section if there is not a classic destination already available to folks? I'm not seeing it in the template!

Not typically, but I see no problem in keeping htis in there

forstisabella · 2023-10-16T21:03:20Z

src/connections/destinations/catalog/hyperengage/index.md

+---
+# Hyperengage Destination
+title: Hyperengage Destination
+hide-boilerplate: true
+hide-dossier: true
+---


This destination is in the catalog as Hyperengage (Actions), so I've updated the destination's name accordingly. I also added the private and beta tags to denote the current status of the destination. The destination ID is pulled from Segment's Public API - including it in the frontmatter like this allows us to programmatically build content on the site (for example, this destination will appear on the list of Actions destinations).

Suggested change

---

# Hyperengage Destination

title: Hyperengage Destination

hide-boilerplate: true

hide-dossier: true

---

---

title: Hyperengage (Actions) Destination

hide-boilerplate: true

hide-dossier: true

private: true

beta: true

id: 651c1db19de92d8e595ff55d

---

forstisabella · 2023-10-16T21:03:22Z

src/connections/destinations/catalog/hyperengage/index.md

+
+Hyperengage (Actions) offers several advantages:
+
+- **Seamless Data Mapping.** Hyperengage streamlines the process of syncing your user and account data. When you link your data, Hyperengage will automatically process Segment's identify, track, and group calls, eliminating the necessity for manual API integrations."


Suggested change

- **Seamless Data Mapping.** Hyperengage streamlines the process of syncing your user and account data. When you link your data, Hyperengage will automatically process Segment's identify, track, and group calls, eliminating the necessity for manual API integrations."

- **Seamless Data Mapping**: Hyperengage streamlines the process of syncing your user and account data. When you link your data with Segment, Hyperengage automatically processes Segment's Identify, Track, and Group calls, eliminating the need for manual API integrations.

forstisabella · 2023-10-16T21:03:25Z

src/connections/destinations/catalog/hyperengage/index.md

+Hyperengage (Actions) offers several advantages:
+
+- **Seamless Data Mapping.** Hyperengage streamlines the process of syncing your user and account data. When you link your data, Hyperengage will automatically process Segment's identify, track, and group calls, eliminating the necessity for manual API integrations."
+- **Pre-configured Mapping.** We have prebuilt mappings tailored for Hyperengage with all the necessary parameters, reducing the need for manual customization.


Suggested change

- **Pre-configured Mapping.** We have prebuilt mappings tailored for Hyperengage with all the necessary parameters, reducing the need for manual customization.

- **Pre-configured Mappings**: The Hyperengage (Actions) Destination has prebuilt mappings tailored for Hyperengage with all the necessary parameters, reducing the need for manual customization.

forstisabella · 2023-10-16T21:03:28Z

src/connections/destinations/catalog/hyperengage/index.md

+
+- **Seamless Data Mapping.** Hyperengage streamlines the process of syncing your user and account data. When you link your data, Hyperengage will automatically process Segment's identify, track, and group calls, eliminating the necessity for manual API integrations."
+- **Pre-configured Mapping.** We have prebuilt mappings tailored for Hyperengage with all the necessary parameters, reducing the need for manual customization.
+- **Direct Data Transfer.** Data moves straight from Segment to Hyperengage, eliminating the need for third-party intermediaries.


Suggested change

- **Direct Data Transfer.** Data moves straight from Segment to Hyperengage, eliminating the need for third-party intermediaries.

- **Direct Data Transfer**: Data moves straight from Segment to Hyperengage, eliminating the need for third-party intermediaries.

forstisabella · 2023-10-16T21:03:32Z

src/connections/destinations/catalog/hyperengage/index.md

+## Getting Started
+
+1. Navigate to the Segment web app and select **Catalog**, then pick **Destinations**.
+2. In the Destinations Catalog, search for "hyperengage" and choose the destination.


Suggested change

2. In the Destinations Catalog, search for "hyperengage" and choose the destination.

2. In the Destinations Catalog, search for "Hyperengage" and select the Hyperengage (Actions) destination.

forstisabella · 2023-10-16T21:03:35Z

src/connections/destinations/catalog/hyperengage/index.md

+
+1. Navigate to the Segment web app and select **Catalog**, then pick **Destinations**.
+2. In the Destinations Catalog, search for "hyperengage" and choose the destination.
+3. Opt for **Configure Hyperengage**.


Suggested change

3. Opt for **Configure Hyperengage**.

3. Click **Add destination**.

forstisabella · 2023-10-16T21:03:41Z

src/connections/destinations/catalog/hyperengage/index.md

+1. Navigate to the Segment web app and select **Catalog**, then pick **Destinations**.
+2. In the Destinations Catalog, search for "hyperengage" and choose the destination.
+3. Opt for **Configure Hyperengage**.
+4. Choose an existing Source to connect to Hyperengage (Actions).


Suggested change

4. Choose an existing Source to connect to Hyperengage (Actions).

4. Choose an existing Source to connect to Hyperengage (Actions) and click **Next**.

5. Enter a name for your destination and click **Create destination**.

forstisabella · 2023-10-16T21:03:43Z

src/connections/destinations/catalog/hyperengage/index.md

+2. In the Destinations Catalog, search for "hyperengage" and choose the destination.
+3. Opt for **Configure Hyperengage**.
+4. Choose an existing Source to connect to Hyperengage (Actions).
+5. Access the [Hyperengage App](https://hyperengage.io/){:target="_blank"}, proceed to **Integration Settings**, and copy the **API Key** & **Workspace Identifier**.


Suggested change

5. Access the [Hyperengage App](https://hyperengage.io/){:target="_blank"}, proceed to **Integration Settings**, and copy the **API Key** & **Workspace Identifier**.

6. Open the [Hyperengage App](https://hyperengage.io/){:target="_blank"}, proceed to **Integration Settings**, and copy the API Key and Workspace Identifier.

forstisabella · 2023-10-16T21:03:45Z

src/connections/destinations/catalog/hyperengage/index.md

+3. Opt for **Configure Hyperengage**.
+4. Choose an existing Source to connect to Hyperengage (Actions).
+5. Access the [Hyperengage App](https://hyperengage.io/){:target="_blank"}, proceed to **Integration Settings**, and copy the **API Key** & **Workspace Identifier**.
+6. Paste the "API Key" & "Workspace Identifier" into the "Hyperengage (Actions)" destination settings within Segment.


Suggested change

6. Paste the "API Key" & "Workspace Identifier" into the "Hyperengage (Actions)" destination settings within Segment.

7. Open the Segment app, navigate to your Hyperengage (Actions) destination, and paste the API Key and Workspace Identifier into the destination's settings page.

forstisabella · 2023-10-17T16:21:37Z

src/connections/destinations/catalog/hyperengage/index.md

@@ -0,0 +1,45 @@
+---
+# Hyperengage Destination
+title: Hyperengage Destination


Suggested change

title: Hyperengage Destination

title: Hyperengage (Actions) Destination

forstisabella · 2023-10-17T16:21:56Z

src/connections/destinations/catalog/hyperengage/index.md

+# Hyperengage Destination
+title: Hyperengage Destination
+hide-boilerplate: true
+hide-dossier: true


Suggested change

hide-dossier: true

hide-dossier: true

beta: true

private: true

id: 651c1db19de92d8e595ff55d

forstisabella · 2023-10-18T22:41:11Z

hey @tcgilbert - can you take a look at this PR when you get a chance?

tcgilbert

please remove template comments

tcgilbert · 2023-10-19T16:44:47Z

src/connections/destinations/catalog/hyperengage/index.md

+hide-dossier: true
+---
+
+<!-- This template is meant for Actions-based destinations that do not have an existing Classic or non-Actions-based version. For Actions Destinations that are a new version of a classic destination, see the doc-template-update.md template. -->


Suggested change

tcgilbert · 2023-10-19T16:44:57Z

src/connections/destinations/catalog/hyperengage/index.md

+
+{% include content/plan-grid.md name="actions" %}
+
+<!-- Include a brief description of the destination here, along with a link to your website. -->


Suggested change

tcgilbert · 2023-10-19T16:45:06Z

src/connections/destinations/catalog/hyperengage/index.md

+{% include content/plan-grid.md name="actions" %}
+
+<!-- Include a brief description of the destination here, along with a link to your website. -->
+<!-- In the section below, explain the value of this actions-based destination. If you don't have a classic version of the destination, remove this section. -->


Suggested change

tcgilbert · 2023-10-19T16:45:17Z

src/connections/destinations/catalog/hyperengage/index.md

+- **Direct Data Transfer**: Data moves straight from Segment to Hyperengage, eliminating the need for third-party intermediaries.
+- **Event Tracking and User Identification**: With Segment's Actions-based destination, you can keep track of events and identify users and organizations in Hyperengage.
+
+<!-- The section below describes how to activate and set up the destination. Include any additional configuration steps not mentioned. For example, acquiring an API key from your system and any setup steps needed to establish a connection to the destination. -->


Suggested change

tcgilbert · 2023-10-19T16:45:28Z

src/connections/destinations/catalog/hyperengage/index.md

+6. Open the [Hyperengage App](https://hyperengage.io/){:target="_blank"}, proceed to **Integration Settings**, and copy the API Key and Workspace Identifier.
+7. Open the Segment app, navigate to your Hyperengage (Actions) destination, and paste the API Key and Workspace Identifier into the destination's settings page.
+
+<!-- The line below will render a table of connection settings (if they exist), Pre-built Mappings, and potential actions. -->


Suggested change

tcgilbert · 2023-10-19T16:45:49Z

src/connections/destinations/catalog/hyperengage/index.md

+<!--
+Additional Context
+
+Include additional information that you think will be useful to the user here. For information that is specific to an individual mapping, please add that as a comment so that the Segment docs team can include it in the auto-generated content for that mapping.
+-->


Suggested change

forstisabella · 2023-10-31T16:16:39Z

hi @zhadier39 - I'm not able to directly edit this branch due to protections on your branch. I've duplicated the contents of this PR in #5606 and we'll use that one to merge the docs into the site!

Add docs for hyperengage actions destination

53d889b

zhadier39 requested a review from a team as a code owner October 16, 2023 12:27

zhadier39 requested review from forstisabella and removed request for a team October 16, 2023 12:27

joe-ayoub-segment requested changes Oct 16, 2023

View reviewed changes

Rephrase data mapping description

faff21f

pwseg requested a review from tcgilbert October 16, 2023 15:57

forstisabella requested changes Oct 16, 2023

View reviewed changes

Make recommended changes

29c8485

zhadier39 requested a review from forstisabella October 17, 2023 07:58

forstisabella approved these changes Oct 17, 2023

View reviewed changes

tcgilbert suggested changes Oct 19, 2023

View reviewed changes

forstisabella added the new-integration Added a new source or destination label Oct 25, 2023

forstisabella mentioned this pull request Oct 31, 2023

Hyperengage (Actions) Destination #5606

Merged

forstisabella closed this Oct 31, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Hyperengage Actions] - Added Documentation for New Destination #5539

[Hyperengage Actions] - Added Documentation for New Destination #5539

zhadier39 commented Oct 16, 2023

joe-ayoub-segment left a comment

joe-ayoub-segment Oct 16, 2023

zhadier39 Oct 16, 2023

forstisabella left a comment

forstisabella Oct 16, 2023 •

edited

Loading

tcgilbert Oct 19, 2023

forstisabella Oct 16, 2023 •

edited

Loading

forstisabella Oct 16, 2023

forstisabella Oct 16, 2023

forstisabella Oct 16, 2023

forstisabella Oct 16, 2023

forstisabella Oct 16, 2023

forstisabella Oct 16, 2023

forstisabella Oct 16, 2023

forstisabella Oct 16, 2023

forstisabella Oct 17, 2023

forstisabella Oct 17, 2023

forstisabella commented Oct 18, 2023

tcgilbert left a comment

tcgilbert Oct 19, 2023

tcgilbert Oct 19, 2023

tcgilbert Oct 19, 2023

tcgilbert Oct 19, 2023

tcgilbert Oct 19, 2023

tcgilbert Oct 19, 2023

forstisabella commented Oct 31, 2023


		Hyperengage (Actions) offers several advantages:

		- Seamless Data Mapping. Hyperengage streamlines the process of syncing your user and account data. By linking your account, identify, track, and group calls with user or account data will be processed by Hyperengage, bypassing the need for manual API integrations.

	- Seamless Data Mapping. Hyperengage streamlines the process of syncing your user and account data. When you link your data, Hyperengage will automatically process Segment's identify, track, and group calls, eliminating the necessity for manual API integrations."
	- Seamless Data Mapping: Hyperengage streamlines the process of syncing your user and account data. When you link your data with Segment, Hyperengage automatically processes Segment's Identify, Track, and Group calls, eliminating the need for manual API integrations.

	- Pre-configured Mapping. We have prebuilt mappings tailored for Hyperengage with all the necessary parameters, reducing the need for manual customization.
	- Pre-configured Mappings: The Hyperengage (Actions) Destination has prebuilt mappings tailored for Hyperengage with all the necessary parameters, reducing the need for manual customization.

	- Direct Data Transfer. Data moves straight from Segment to Hyperengage, eliminating the need for third-party intermediaries.
	- Direct Data Transfer: Data moves straight from Segment to Hyperengage, eliminating the need for third-party intermediaries.

	2. In the Destinations Catalog, search for "hyperengage" and choose the destination.
	2. In the Destinations Catalog, search for "Hyperengage" and select the Hyperengage (Actions) destination.

	3. Opt for Configure Hyperengage.
	3. Click Add destination.

	4. Choose an existing Source to connect to Hyperengage (Actions).
	4. Choose an existing Source to connect to Hyperengage (Actions) and click Next.
	5. Enter a name for your destination and click Create destination.

	5. Access the [Hyperengage App](https://hyperengage.io/){:target="_blank"}, proceed to Integration Settings, and copy the API Key & Workspace Identifier.
	6. Open the [Hyperengage App](https://hyperengage.io/){:target="_blank"}, proceed to Integration Settings, and copy the API Key and Workspace Identifier.

	6. Paste the "API Key" & "Workspace Identifier" into the "Hyperengage (Actions)" destination settings within Segment.
	7. Open the Segment app, navigate to your Hyperengage (Actions) destination, and paste the API Key and Workspace Identifier into the destination's settings page.

	title: Hyperengage Destination
	title: Hyperengage (Actions) Destination

-hide-dossier: true
+hide-dossier: true
+beta: true
+private: true
+id: 651c1db19de92d8e595ff55d


		{% include content/plan-grid.md name="actions" %}

		<!-- Include a brief description of the destination here, along with a link to your website. -->

[Hyperengage Actions] - Added Documentation for New Destination #5539

[Hyperengage Actions] - Added Documentation for New Destination #5539

Conversation

zhadier39 commented Oct 16, 2023

Proposed changes

Merge timing

joe-ayoub-segment left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

forstisabella left a comment

Choose a reason for hiding this comment

forstisabella Oct 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

forstisabella Oct 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

forstisabella commented Oct 18, 2023

tcgilbert left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

forstisabella commented Oct 31, 2023

forstisabella Oct 16, 2023 •

edited

Loading

forstisabella Oct 16, 2023 •

edited

Loading