Create Heading with Papyrs API on New Query Results from Snowflake API

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

Trigger workflow on

New Query Results from the Snowflake API

Next, do this

Create Heading with the Papyrs 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 Papyrs action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Query Results trigger
1. Connect your Snowflake account
2. Configure timer
3. Configure SQL Query
4. Optional- Configure Primary key
5. Optional- Configure Emit individual events
Configure the Create Heading action
1. Connect your Papyrs account
2. Optional- Configure Subsite
3. Select a Page
4. Configure Value
5. Optional- Select a Format
6. Optional- Select a Style Class
7. Optional- Select a Heading
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 Query Results on Snowflake

Description:Run a SQL query on a schedule, triggering a workflow for each row of results

Version:0.2.2

Key:snowflake-query-results

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";
import { v4 as uuidv4 } from "uuid";

export default {
  ...common,
  type: "source",
  key: "snowflake-query-results",
  name: "New Query Results",
  // eslint-disable-next-line
  description: "Run a SQL query on a schedule, triggering a workflow for each row of results",
  version: "0.2.2",
  props: {
    ...common.props,
    sqlQuery: {
      type: "string",
      label: "SQL Query",
      description: "Run this query on a schedule, triggering the workflow for each row of results",
    },
    // Ordering props correctly
    timer: common.props.timer,
    dedupeKey: {
      type: "string",
      label: "Primary key",
      description: "The column in your query to use for de-duplication. Duplicate rows won't trigger your workflow",
      optional: true,
    },
    emitIndividualEvents: {
      propDefinition: [
        common.props.snowflake,
        "emitIndividualEvents",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateMeta(data) {
      const {
        row: { [this.dedupeKey]: id = uuidv4() },
        timestamp: ts,
      } = data;
      const summary = `New event (ID: ${id})`;
      return {
        id,
        summary,
        ts,
      };
    },
    generateMetaForCollection(data) {
      const { timestamp: ts } = data;
      const id = uuidv4();
      const summary = `New event (ID: ${id})`;
      return {
        id,
        summary,
        ts,
      };
    },
    getStatement() {
      return {
        sqlText: this.sqlQuery,
      };
    },
  },
};

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 changes on this schedule
SQL Query	`sqlQuery`	`string`	Run this query on a schedule, triggering the workflow for each row of results
Primary key	`dedupeKey`	`string`	The column in your query to use for de-duplication. Duplicate rows won't trigger your workflow
Emit individual events	`emitIndividualEvents`	`boolean`	Defaults to `true`, triggering workflows on each record in the result set. Set to `false` to emit records in batch (advanced)

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#

Create Heading on Papyrs

Description:Create Heading. [See the docs here](https://about.papyrs.com/@docs/API#Create-Text-box/Heading)

Version:0.0.1

Key:papyrs-create-heading

View on GitHub

Papyrs Overview#

The Papyrs API facilitates the creation and manipulation of rich text documents in your Papyrs intranet. With it, you can automate the handling of text-documents, forms, and pages within your organization's Papyrs account. When combined with Pipedream's capacity to connect to various APIs, the Papyrs API can be a powerful tool for document-driven workflow automation. You can trigger actions in Papyrs based on events from other apps, process Papyrs data for insights, or synchronize Papyrs content with external systems, databases, or file storage solutions.

Action Code#

import app from "../../papyrs.app.mjs";
import options from "../../common/enums.mjs";

export default {
  name: "Create Heading",
  description: "Create Heading. [See the docs here](https://about.papyrs.com/@docs/API#Create-Text-box/Heading)",
  key: "papyrs-create-heading",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    subsite: {
      propDefinition: [
        app,
        "subsite",
      ],
    },
    page: {
      propDefinition: [
        app,
        "page",
      ],
    },
    value: {
      propDefinition: [
        app,
        "value",
      ],
    },
    format: {
      propDefinition: [
        app,
        "format",
      ],
    },
    styleClass: {
      type: "string",
      label: "Style Class",
      description: "The style class of the heading.",
      options: options.CREATE_HEADING_STYLE_CLASS,
      optional: true,
    },
    heading: {
      type: "string",
      label: "Heading",
      description: "The size of the heading. `h0` is largest, `h4` is smallest.",
      options: options.CREATE_HEADING_HEADING,
      optional: true,
    },
  },
  async run({ $ }) {
    const data = {
      widget: {
        val: this.value,
        format: this.format,
        styleclass: this.styleClass,
        heading: this.heading,
      },
    };
    const res = await this.app.createHeading(
      data,
      this.page,
      this.subsite,
      $,
    );
    $.export("$summary", "Heading successfully created");
    return res;
  },
};

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
Papyrs	`app`	`app`	This component uses the Papyrs app.
Subsite	`subsite`	`string`	The subsite to use for this action. Use `home` for the default subsite.
Page	`page`	`string`	Select a value from the drop down menu.
Value	`value`	`string`	The value of the widget.
Format	`format`	`string`	Select a value from the drop down menu:`{ "value": "html", "label": "html — The value is HTML and is used unescaped (but sanitized to remove certain tags)." }{ "value": "text", "label": "text — The value is Text, any HTML tags are escaped, and line breaks are converted." }`
Style Class	`styleClass`	`string`	Select a value from the drop down menu:`lineemphasisbarsquoteboxquote`
Heading	`heading`	`string`	Select a value from the drop down menu:`h0h1h2h3h4`

Action Authentication#

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

To get your API Token, go to Site Settings > Integrations & SSO > API to request API access to your account.

Once API support is enabled, Site Owners can go to Site Settings > Integrations & SSO and click Generate Token to create a new unique API token for users.
You can get your Site Name by looking at the URL on your Papyrs dashboard -- it has the structure, https://{site_name}.papyrs.com/@home/Getting-Started.