Record Observation with Gami5d API on Failed Task in Schema from Snowflake API

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

Trigger workflow on

Failed Task in Schema from the Snowflake 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 Snowflake 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 Failed Task in Schema trigger
1. Connect your Snowflake account
2. Configure timer
3. Select a Database
4. Select one or more Schema
5. Optional- Configure Task Name
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#

Failed Task in Schema on Snowflake

Description:Emit new events when a task fails in a database schema

Version:0.1.2

Key:snowflake-failed-task-in-schema

View on GitHub

Snowflake Overview#

Snowflake offers a cloud database and related tools to help developers create robust, secure, and scalable data warehouses. See Snowflake's Key Concepts & Architecture.

Getting Started

1. Create a user, role and warehouse in Snowflake

Snowflake recommends you create a new user, role, and warehouse when you integrate a third-party tool like Pipedream. This way, you can control permissions via the user / role, and separate Pipedream compute and costs with the warehouse. You can do this directly in the Snowflake UI.

We recommend you create a read-only account if you only need to query Snowflake. If you need to insert data into Snowflake, add permissions on the appropriate objects after you create your user.

2. Enter those details in Pipedream

Visit https://pipedream.com/accounts. Click the button to Connect an App. Enter the required Snowflake account data.

You'll only need to connect your account once in Pipedream. You can connect this account to multiple workflows to run queries against Snowflake, insert data, and more.

3. Build your first workflow

Visit https://pipedream.com/new to build your first workflow. Pipedream workflows let you connect Snowflake with 1,000+ other apps. You can trigger workflows on Snowflake queries, sending results to Slack, Google Sheets, or any app that exposes an API. Or you can accept data from another app, transform it with Python, Node.js, Go or Bash code, and insert it into Snowflake.

Learn more at Pipedream University.

Trigger Code#

import common from "../common.mjs";

export default {
  ...common,
  props: {
    ...common.props,
    timer: {
      description: "Watch for failed tasks on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: 15 * 60,
      },
    },
    database: {
      propDefinition: [
        common.props.snowflake,
        "database",
      ],
    },
    schemas: {
      propDefinition: [
        common.props.snowflake,
        "schema",
        (configuredProps) => ({
          database: configuredProps.database,
        }),
      ],
      type: "string[]",
    },
    taskName: {
      type: "string",
      label: "Task Name",
      description: "The name of the task to watch for failures. It allows you to use Regex to match multiple tasks.",
      optional: true,
    },
  },
  type: "source",
  key: "snowflake-failed-task-in-schema",
  // eslint-disable-next-line
  name: "Failed Task in Schema",
  description: "Emit new events when a task fails in a database schema",
  version: "0.1.2",
  async run() {
    await this.emitFailedTasks({
      database: this.database,
      schemas: this.schemas,
      taskName: this.taskName,
    });
  },
};

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
Snowflake	`snowflake`	`app`	This component uses the Snowflake app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	Watch for failed tasks on this schedule
Database	`database`	`string`	Select a value from the drop down menu.
Schema	`schemas`	`string[]`	Select a value from the drop down menu.
Task Name	`taskName`	`string`	The name of the task to watch for failures. It allows you to use Regex to match multiple tasks.

Trigger Authentication#

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

We recommend you create a read-only account if you only need to query Snowflake. If you need to insert data into Snowflake, add permissions on the appropriate objects after you create your user.

About Snowflake#

A data warehouse built for the cloud

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