Create Page with Documenterra API on New, Updated, or Deleted Warehouse from Snowflake API

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

Trigger workflow on

New, Updated, or Deleted Warehouse from the Snowflake API

Next, do this

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

Select this integration
Configure the New, Updated, or Deleted Warehouse trigger
1. Connect your Snowflake account
2. Configure timer
3. Optional- Select one or more Query Types
4. Optional- Select one or more Warehouse Name
Configure the Create Page action
1. Connect your Documenterra account
2. Select a Project Identity
3. Configure Page ID
4. Configure Assignee User Name
5. Configure Owner User Name
6. Select a Status Name
7. Optional- Configure Page Title
8. Optional- Configure Body HTML
9. Optional- Configure Index Keywords
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, Updated, or Deleted Warehouse on Snowflake

Description:Emit new events when a warehouse is created, altered, or dropped

Version:0.1.2

Key:snowflake-change-to-warehouse

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-watch-for-resource-changes.mjs";

export default {
  ...common,
  props: {
    ...common.props,
    warehouses: {
      propDefinition: [
        common.props.snowflake,
        "warehouses",
      ],
      optional: true,
    },
  },
  type: "source",
  key: "snowflake-change-to-warehouse",
  // eslint-disable-next-line
  name: "New, Updated, or Deleted Warehouse",
  description: "Emit new events when a warehouse is created, altered, or dropped",
  version: "0.1.2",
  async run() {
    await this.watchObjectsAndEmitChanges("WAREHOUSE", this.warehouses, this.queryTypes);
  },
};

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. Snowflake query history has roughly a 45 minute delay
Query Types	`queryTypes`	`string[]`	Select a value from the drop down menu:`CREATEALTERDROP`
Warehouse Name	`warehouses`	`string[]`	Select a value from the drop down menu.

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 Page on Documenterra

Description:Creates a new page. [See the documentation](https://documenterra.ru/docs/user-manual/api-sozdaniye-stranitsy.html)

Version:0.0.1

Key:documenterra-create-page

View on GitHub

Action Code#

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

export default {
  key: "documenterra-create-page",
  name: "Create Page",
  description: "Creates a new page. [See the documentation](https://documenterra.ru/docs/user-manual/api-sozdaniye-stranitsy.html)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    projectId: {
      propDefinition: [
        app,
        "projectId",
      ],
    },
    id: {
      type: "string",
      label: "Page ID",
      description: "The unique identifier for the page.",
    },
    assigneeUserName: {
      type: "string",
      label: "Assignee User Name",
      description: "Login of the artist to whom the page is assigned.",
    },
    ownerUserName: {
      type: "string",
      label: "Owner User Name",
      description: "The name of the user who is the owner of the page.",
    },
    statusName: {
      type: "string",
      label: "Status Name",
      description: "Page workflow status.",
      options: [
        "Ready",
        "Draft",
        "Under Review",
      ],
    },
    title: {
      type: "string",
      label: "Page Title",
      description: "The title of the page.",
      optional: true,
    },
    bodyHtml: {
      type: "string",
      label: "Body HTML",
      description: "HTML content of the page.",
      optional: true,
    },
    indexKeywords: {
      type: "string[]",
      label: "Index Keywords",
      description: "An array of strings containing keywords to be used when creating the page.",
      optional: true,
    },
  },
  methods: {
    createPage({
      projectId, ...args
    } = {}) {
      return this.app.post({
        path: `/projects/${projectId}/articles`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createPage,
      projectId,
      assigneeUserName,
      id,
      ownerUserName,
      statusName,
      title,
      bodyHtml,
      indexKeywords,
    } = this;

    const response = await createPage({
      $,
      projectId,
      data: {
        assigneeUserName,
        id,
        ownerUserName,
        statusName,
        title,
        bodyHtml,
        indexKeywords,
      },
    });

    $.export("$summary", `Successfully created a new page with ID: \`${response?.id}\`.`);
    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
Documenterra	`app`	`app`	This component uses the Documenterra app.
Project Identity	`projectId`	`string`	Select a value from the drop down menu.
Page ID	`id`	`string`	The unique identifier for the page.
Assignee User Name	`assigneeUserName`	`string`	Login of the artist to whom the page is assigned.
Owner User Name	`ownerUserName`	`string`	The name of the user who is the owner of the page.
Status Name	`statusName`	`string`	Select a value from the drop down menu:`ReadyDraftUnder Review`
Page Title	`title`	`string`	The title of the page.
Body HTML	`bodyHtml`	`string`	HTML content of the page.
Index Keywords	`indexKeywords`	`string[]`	An array of strings containing keywords to be used when creating the page.