Record Observation with Gami5d API on New Guild Member (Instant) from Discord API

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

Trigger workflow on

New Guild Member (Instant) from the Discord 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 Discord 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 Guild Member (Instant) trigger
1. Connect your Discord account
2. Configure discordApphook
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 Guild Member (Instant) on Discord

Description:Emit new event for each new member added to a guild

Version:0.0.3

Key:discord-new-guild-member

View on GitHub

Discord Overview#

The Discord API interacts seamlessly with Pipedream, empowering you to craft customized automations and workflows for your Discord server. With this powerful integration, you can automate tasks like message posting, user management, and notifications, based on a myriad of triggers and actions from different apps. These automations can enhance the Discord experience for community moderators and members, by synchronizing with external tools, organizing community engagement, and streamlining notifications.

Trigger Code#

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

export default {
  key: "discord-new-guild-member",
  name: "New Guild Member (Instant)",
  description: "Emit new event for each new member added to a guild",
  version: "0.0.3",
  dedupe: "unique",
  type: "source",
  props: {
    discord,
    discordApphook: {
      type: "$.interface.apphook",
      appProp: "discord",
      eventNames: [
        "GUILD_MEMBER_ADD",
      ],
    },
  },
  async run(event) {
    this.$emit(event, {
      id: `${event.userId}${event.guildId}`,
      summary: `Member ${event.displayName} added`,
      ts: Date.now(),
    });
  },
};

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
Discord	`discord`	`app`	This component uses the Discord app.
	`discordApphook`	`$.interface.apphook`

Trigger Authentication#

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

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

botemailidentifyguilds

About Discord#

Use this app to create a Discord source that emits messages from your guild to a Pipedream workflow.

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.2

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.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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"