Create Personalised Short Link with Hyperise API on New Interaction Events (Instant) from Slack API

Pipedream makes it easy to connect APIs for Hyperise, Slack and 2,000+ other apps remarkably fast.

Trigger workflow on

New Interaction Events (Instant) from the Slack API

Next, do this

Create Personalised Short Link with the Hyperise API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Slack trigger and Hyperise action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Interaction Events (Instant) trigger
1. Connect your Slack account
2. Configure alert
3. Optional- Configure Action IDs
4. Optional- Select one or more Channels
5. Configure slackApphook
Configure the Create Personalised Short Link action
1. Connect your Hyperise account
2. Select a Image Template Hash
3. Configure Destination URL
4. Configure Page Title
5. Configure Page Description
6. Optional- Configure First Name
7. Optional- Configure Last Name
8. Optional- Configure Profile URL
9. Optional- Configure Job Title
10. Optional- Configure Email
11. Optional- Configure Phone
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Interaction Events (Instant) on Slack

Description:Emit new events on new Slack [interactivity events](https://api.slack.com/interactivity) sourced from [Block Kit interactive elements](https://api.slack.com/interactivity/components), [Slash commands](https://api.slack.com/interactivity/slash-commands), or [Shortcuts](https://api.slack.com/interactivity/shortcuts).

Version:0.0.13

Key:slack-new-interaction-event-received

View on GitHub

New Interaction Events (Instant) Overview#

Slack messages can contain interactive elements like buttons, dropdowns, radio buttons, and more. This source subscribes to interactive events, like when a button is clicked in a message.

Example of a Slack button

Then this source will be triggered when you or another Slack user in your workspace clicks a button, selects an option or fills out a form.

Example feed of interaction events coming from Slack

With this trigger, you can build workflows that perform some work with other APIs or services, and then reply back to the original message.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  name: "New Interaction Events (Instant)",
  version: "0.0.13",
  key: "slack-new-interaction-event-received",
  description: "Emit new events on new Slack [interactivity events](https://api.slack.com/interactivity) sourced from [Block Kit interactive elements](https://api.slack.com/interactivity/components), [Slash commands](https://api.slack.com/interactivity/slash-commands), or [Shortcuts](https://api.slack.com/interactivity/shortcuts).",
  type: "source",
  props: {
    ...common.props,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Please note that only messages created via Pipedream's [Send Block Kit Message](https://pipedream.com/apps/slack/actions/send-block-kit-message) Action, or via API call from the Pipedream app will emit an interaction event with this trigger. \n\nBlock kit messages sent directly via the Slack's block kit builder will not trigger an interaction event. \n\nSee the [documentation](https://pipedream.com/apps/slack/triggers/new-interaction-event-received) for more details.",
    },
    action_ids: {
      type: "string[]",
      label: "Action IDs",
      description: "Filter interaction events by specific `action_id`'s to subscribe for new interaction events. If none are specified, all `action_ids` created via Pipedream will emit new events.",
      optional: true,
      default: [],
    },
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Filter interaction events by one or more channels. If none selected, any interaction event in any channel will emit new events.",
      optional: true,
      default: [],
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      /**
       * Subscribes to potentially 4 different events:
       * `interaction_events` - all interaction events on the authenticated account
       * `interaction_events:${action_id}` - all interaction events with a specific given action_id
       * `interaction_events:${channel_id}` - all interaction events within a specific channel
       * `interaction_events:${channel_id}:${action_id}` - action_id within a specific channel
       * @returns string[]
       */
      async eventNames() {
        // start with action_ids, since they can be the most specific
        const action_events = this.action_ids.reduce((carry, action_id) => {
          // if channels are provided, spread them
          if (this.conversations && this.conversations.length > 0) {
            return [
              ...carry,
              ...this.conversations.map(
                (channel) => `interaction_events:${channel}:${action_id}`,
              ),
            ];
          }

          return [
            ...carry,
            `interaction_events:${action_id}`,
          ];
        }, []);

        if (action_events.length > 0) return action_events;

        // if no action_ids are specified, move down to channels
        const channel_events = this.conversations.map(
          (channel) => `interaction_events:${channel}`,
        );

        if (channel_events.length > 0) return channel_events;

        // if not specific action_ids or channels are specified, subscribe to all events
        return [
          "interaction_events",
        ];
      },
    },
  },
  methods: {},
  async run(event) {
    this.$emit(
      {
        event,
      },
      {
        summary: `New interaction event${
          event?.channel?.id
            ? ` in channel ${event.channel.id}`
            : ""
        }${
          event.actions?.length > 0
            ? ` from action_ids ${event.actions
              .map((action) => action.action_id)
              .join(", ")}`
            : ""
        }`,
        ts: Date.now(),
      },
    );
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Action IDs	`action_ids`	`string[]`	Filter interaction events by specific `action_id`'s to subscribe for new interaction events. If none are specified, all `action_ids` created via Pipedream will emit new events.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`

Trigger Authentication#

Slack uses OAuth authentication. When you connect your Slack account, Pipedream will open a popup window where you can sign into Slack and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Slack API.

Pipedream requests the following authorization scopes when you connect your account:

bookmarks:writecalls:readcalls:writechannels:historychannels:readchannels:writednd:readdnd:writeemoji:readfiles:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writepins:readpins:writereactions:readreactions:writereminders:readreminders:writeremote_files:readremote_files:sharestars:readstars:writeteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:usercommandsfiles:write:userusers.profile:writeusers.profile:readsearch:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

Action#

Create Personalised Short Link on Hyperise

Description:Creates a personalised short URL from provided inputs. [See the documentation](https://support.hyperise.com/en/api/Personalised-Short-Links-API)

Version:0.0.1

Key:hyperise-create-personalised-short-link

View on GitHub

Hyperise Overview#

The Hyperise API lets you dynamically personalize images with user-specific data, making it easier to create tailored visual content for each recipient. With Pipedream, you can automate this personalization process by integrating Hyperise with various apps to generate and share custom images on the fly. This could be particularly useful for marketing campaigns, sales outreach, or social media engagement where personalized content significantly boosts user interaction.

Action Code#

import hyperise from "../../hyperise.app.mjs";

export default {
  key: "hyperise-create-personalised-short-link",
  name: "Create Personalised Short Link",
  description: "Creates a personalised short URL from provided inputs. [See the documentation](https://support.hyperise.com/en/api/Personalised-Short-Links-API)",
  version: "0.0.1",
  type: "action",
  props: {
    hyperise,
    imageTemplateHash: {
      propDefinition: [
        hyperise,
        "imageTemplateHash",
      ],
    },
    destinationUrl: {
      type: "string",
      label: "Destination URL",
      description: "The URL to create a personalised short URL for",
    },
    pageTitle: {
      type: "string",
      label: "Page Title",
      description: "Title of the page",
    },
    pageDescription: {
      type: "string",
      label: "Page Description",
      description: "Description of the page",
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "Personalisation Data - first name",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Personalisation Data",
      optional: true,
    },
    profileUrl: {
      type: "string",
      label: "Profile URL",
      description: "Personalisation Data - Image URL of the prospects profile image",
      optional: true,
    },
    jobTitle: {
      type: "string",
      label: "Job Title",
      description: "Personalisation Data - job title",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "Personalisation Data - email address",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Personalisation Data - phone number",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.hyperise.createPersonalisedShortUrl({
      $,
      data: {
        image_hash: this.imageTemplateHash,
        url: this.destinationUrl,
        title: this.pageTitle,
        desc: this.pageDescription,
        query_params: {
          first_name: this.firstName,
          last_name: this.lastName,
          profile_url: this.profileUrl,
          job_title: this.jobTitle,
          email: this.email,
          phone: this.phone,
        },
      },
    });
    $.export("$summary", `Successfully created personalised short URL: ${response.link}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Hyperise	`hyperise`	`app`	This component uses the Hyperise app.
Image Template Hash	`imageTemplateHash`	`string`	Select a value from the drop down menu.
Destination URL	`destinationUrl`	`string`	The URL to create a personalised short URL for
Page Title	`pageTitle`	`string`	Title of the page
Page Description	`pageDescription`	`string`	Description of the page
First Name	`firstName`	`string`	Personalisation Data - first name
Last Name	`lastName`	`string`	Personalisation Data
Profile URL	`profileUrl`	`string`	Personalisation Data - Image URL of the prospects profile image
Job Title	`jobTitle`	`string`	Personalisation Data - job title
Email	`email`	`string`	Personalisation Data - email address
Phone	`phone`	`string`	Personalisation Data - phone number

Action Authentication#

Hyperise uses API keys for authentication. When you connect your Hyperise account, Pipedream securely stores the keys so you can easily authenticate to Hyperise APIs in both code and no-code steps.

To retrieve your API tokens,

Navigate to your Hyperise and sign in
Go to “Settings” > “API”

About Hyperise#

Hyperise is essentially an image personalisation toolkit. These images can be used in outreach and on your website landing pages. Hyperise integrates with 1000's of MarTech, so whatever your outreach and website builder tools you're using, we most likely integrate with them.

More Ways to Connect Hyperise + Slack#

Other Popular Integrations#

Create Personalised Short Link with Hyperise API on New Star Added To Message (Instant) from Slack API

Slack + Hyperise

Create Personalised Short Link with Hyperise API on New Interaction Events (Instant) from Slack API

Pipedream makes it easy to connect APIs for Hyperise, Slack and 2,000+ other apps remarkably fast.

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,000+apps by most popular

1
-
24
of
2,000+
apps by most popular