Record Observation with Gami5d API on New Reaction Added (Instant) from Slack API

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

Trigger workflow on

New Reaction Added (Instant) from the Slack API

Next, do this

Record Observation with the Gami5d API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Reaction Added (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Optional- Configure Ignore Bots
5. Optional- Select one or more Icon (emoji)
6. Optional- Configure Include User Data
Configure the Record Observation action
1. Connect your Gami5d account
2. Configure Player Unique Ref
3. Optional- Configure User ID
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 Reaction Added (Instant) on Slack

Description:Emit new event when a member has added an emoji reaction to a message

Version:1.1.23

Key:slack-new-reaction-added

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. Once you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Automate posting updates to your team channels
Create a bot to answer common questions
Integrate with your existing tools and services
And much more!

Trigger Code#

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

export default {
  ...common,
  key: "slack-new-reaction-added",
  name: "New Reaction Added (Instant)",
  version: "1.1.23",
  description: "Emit new event when a member has added an emoji reaction to a message",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Select one or more channels to monitor for new messages.",
      optional: true,
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        if (this.conversations?.length) {
          const conversations = [];
          for (const conversation of this.conversations) {
            conversations.push(`reaction_added:${conversation}`);
          }
          return conversations;
        }

        return [
          "reaction_added",
        ];
      },
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
    iconEmoji: {
      propDefinition: [
        common.props.slack,
        "icon_emoji",
      ],
      description: "Select one or more emojis to use as a filter. E.g. `fire, email`",
      type: "string[]",
      optional: true,
    },
    includeUserData: {
      label: "Include User Data",
      description: "Include user object in the response. Default `false`",
      type: "boolean",
      optional: true,
      default: false,
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New reaction added";
    },
    async processEvent(event) {
      let iconEmojiParsed = [];

      try {
        iconEmojiParsed = typeof this.iconEmoji === "string" ?
          JSON.parse(this.iconEmoji) :
          this.iconEmoji;
      } catch (error) {
        iconEmojiParsed = this.iconEmoji.replace(/\s+/g, "").split(",");
      }

      if (
        ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) ||
        (iconEmojiParsed?.length > 0 && !iconEmojiParsed.includes(event.reaction))
      ) {
        return;
      }

      if (this.includeUserData) {
        const userResponse = await this.slack.usersInfo({
          user: event.user,
        });
        const itemUserResponse = await this.slack.usersInfo({
          user: event.user,
        });

        event.userInfo = userResponse.user;
        event.itemUserInfo = itemUserResponse.user;
      }

      event.message = await this.getMessage({
        channel: event.item.channel,
        event_ts: event.item.ts,
      });

      return event;
    },
  },
  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.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots
Icon (emoji)	`iconEmoji`	`string[]`	Select a value from the drop down menu.
Include User Data	`includeUserData`	`boolean`	Include user object in the response. Default `false`

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:

channels:historychannels:readchannels:writeemoji:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writereactions:readreactions:writereminders:readreminders:writestars:readteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:userfiles:write:usercommandsusers.profile:writeusers.profile: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#

Record Observation on Gami5d

Description:Record an observation for evaluation in the gami5d platform. [See the documentation](https://app.gami5d.com/web/api/docs)

Version:0.0.1

Key:gami5d-record-observation

View on GitHub

Action Code#

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

export default {
  key: "gami5d-record-observation",
  name: "Record Observation",
  description: "Record an observation for evaluation in the gami5d platform. [See the documentation](https://app.gami5d.com/web/api/docs)",
  version: "0.0.1",
  type: "action",
  props: {
    gami5d,
    playerUniqueRef: {
      type: "string",
      label: "Player Unique Ref",
      description: "The unique reference for the player in your system to identify the player and link this observation. This reference should have been provided when creating the player. Example: `P256310`. If the unique reference is not found, then a new player will be created.",
      reloadProps: true,
    },
    userId: {
      type: "string",
      label: "User ID",
      description: "Provide an ID which will be marked as the author of this record. Example: `john.doe@myinc.com`",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    const attributes = await this.gami5d.listAttributes();
    for (const attribute of attributes) {
      props[attribute.key] = {
        type: "string",
        label: attribute.key,
        description: attribute.label,
      };
    }
    return props;
  },
  async run({ $ }) {
    const attributes = await this.gami5d.listAttributes();
    const attributeValues = {};
    for (const attribute of attributes) {
      attributeValues[attribute.key] = this[attribute.key];
    }

    const response = await this.gami5d.recordObservation({
      $,
      data: {
        client_id: this.gami5d.$auth.client_id,
        project_id: this.gami5d.$auth.project_id,
        player_unique_ref: this.playerUniqueRef,
        user_id: this.userId,
        attributes: [
          attributeValues,
        ],
      },
    });
    $.export("$summary", "Successfully recorded observation");
    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
Gami5d	`gami5d`	`app`	This component uses the Gami5d app.
Player Unique Ref	`playerUniqueRef`	`string`	The unique reference for the player in your system to identify the player and link this observation. This reference should have been provided when creating the player. Example: `P256310`. If the unique reference is not found, then a new player will be created.
User ID	`userId`	`string`	Provide an ID which will be marked as the author of this record. Example: `john.doe@myinc.com`

Action Authentication#

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

To retrieve your Access Key, Secret Access Key, Project ID, and Client ID

Navigate to your Gami5d account and sign in
Go to “Core” > “Project Home”
Click on one of your projects
Under the "API Credentials" card hit "Generate New Credential".

Note: Your Secret Access Key is displayed once after it is generated. Access Key, Project Id, and Client ID remain accessible via "Toolkit" > "API Credentials".

Record Observation with Gami5d API on New Reaction Added (Instant) from Slack API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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