Get PDF with Puppeteer API on New Message In Channels (Instant) from Slack API

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

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

Get PDF with the Puppeteer API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Message In Channels (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Optional- Configure Resolve Names
5. Optional- Configure Ignore Bots
6. Optional- Configure Ignore replies in threads
Configure the Get PDF action
1. Connect your Puppeteer account
2. Configure URL
3. Optional- Configure Download Path
4. Optional- Configure Display Header Footer
5. Optional- Configure Footer Template
6. Optional- Select a Format
7. Optional- Configure Header Template
8. Optional- Configure Height
9. Optional- Configure Landscape
10. Optional- Configure Bottom Margin
11. Optional- Configure Left Margin
12. Optional- Configure Right Margin
13. Optional- Configure Top Margin
14. Optional- Configure Omit Background
15. Optional- Configure Page Ranges
16. Optional- Configure Prefer CSS Page Size
17. Optional- Configure Print Background
18. Optional- Configure Scale
19. Optional- Configure Timeout
20. Optional- Configure Width
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 Message In Channels (Instant) on Slack

Description:Emit new event when a new message is posted to one or more channels

Version:1.0.17

Key:slack-new-message-in-channels

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 constants from "../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "slack-new-message-in-channels",
  name: "New Message In Channels (Instant)",
  version: "1.0.17",
  description: "Emit new event when a new message is posted to one or more channels",
  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() {
        return this.conversations || [
          "message",
        ];
      },
    },
    resolveNames: {
      propDefinition: [
        common.props.slack,
        "resolveNames",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
    ignoreThreads: {
      type: "boolean",
      label: "Ignore replies in threads",
      description: "Ignore replies to messages in threads",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New message in channel";
    },
    async processEvent(event) {
      if (event.type !== "message") {
        console.log(`Ignoring event with unexpected type "${event.type}"`);
        return;
      }
      if (event.subtype && !constants.ALLOWED_MESSAGE_IN_CHANNEL_SUBTYPES.includes(event.subtype)) {
        // This source is designed to just emit an event for each new message received.
        // Due to inconsistencies with the shape of message_changed and message_deleted
        // events, we are ignoring them for now. If you want to handle these types of
        // events, feel free to change this code!!
        console.log("Ignoring message with subtype.");
        return;
      }
      if ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) {
        return;
      }
      console.log(event.s);
      // There is no thread message type only the thread_ts field
      // indicates if the message is part of a thread in the event.
      if (this.ignoreThreads && event.thread_ts) {
        console.log("Ignoring reply in thread");
        return;
      }
      if (this.resolveNames) {
        if (event.user) {
          event.user_id = event.user;
          event.user = await this.getUserName(event.user);
        } else if (event.bot_id) {
          event.bot = await this.getBotName(event.bot_id);
        }
        event.channel_id = event.channel;
        event.channel = await this.getConversationName(event.channel);
        if (event.team) {
          event.team_id = event.team;
          event.team = await this.getTeamName(event.team);
        }
      }
      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`
Resolve Names	`resolveNames`	`boolean`	Instead of returning `channel`, `team`, and `user` as IDs, return their human-readable names.
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots
Ignore replies in threads	`ignoreThreads`	`boolean`	Ignore replies to messages in threads

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:

bookmarks:writecalls:readcalls:writechannels:historychannels:readchannels:writednd:readdnd:writeemoji:readfiles:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writepins:readpins:writereactions:readreactions:writereminders:readreminders:writeremote_files:readremote_files:sharestars:readstars:writeteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:usercommandsfiles:write:userusers.profile:writeusers.profile:readsearch: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#

Get PDF on Puppeteer

Description:Generate a PDF of a page using Puppeteer. [See the documentation](https://pptr.dev/api/puppeteer.page.pdf)

Version:1.0.1

Key:puppeteer-get-pdf

View on GitHub

Puppeteer Overview#

Puppeteer is a Node.js library which provides a high-level API to control Chrome/Chromium over the DevTools Protocol. Puppeteer runs in headless mode on Chromium on Pipedream.

Using Puppeteer you can perform tasks including:

Capture Screenshots: Convert webpages into images.
Processing PDFs: parse and scan PDFs.
Web Scraping: Extract data from websites.
UI/UX Testing: Verify user interface and experience.
Integration with Test Frameworks: Combine with testing frameworks.
Task Automation: Automate web-related tasks like form filling.
Functional Testing: Automate user interactions to test web application functionality.
Regression Testing: Ensure new code changes don't introduce bugs.

Action Code#

import puppeteer from "../../puppeteer.app.mjs";
import constants from "../../common/constants.mjs";
import fs from "fs";

export default {
  key: "puppeteer-get-pdf",
  name: "Get PDF",
  description: "Generate a PDF of a page using Puppeteer. [See the documentation](https://pptr.dev/api/puppeteer.page.pdf)",
  version: "1.0.1",
  type: "action",
  props: {
    puppeteer,
    url: {
      type: "string",
      label: "URL",
      description: "The URL of the page to scrape.",
    },
    downloadPath: {
      type: "string",
      label: "Download Path",
      description: "Download the PDF to the `/tmp` directory with the specified filename",
      optional: true,
    },
    displayHeaderFooter: {
      type: "boolean",
      label: "Display Header Footer",
      description: "Whether to show the header and footer.",
      optional: true,
      default: false,
    },
    footerTemplate: {
      type: "string",
      label: "Footer Template",
      description: "HTML template for the print footer.",
      optional: true,
    },
    format: {
      type: "string",
      label: "Format",
      description: "The paper format of the PDF",
      options: constants.PAPER_FORMAT,
      optional: true,
    },
    headerTemplate: {
      type: "string",
      label: "Header Template",
      description: "HTML template for the print header. Should be valid HTML with the following classes used to inject values into them: `date` - formatted print date, `title` - document title, `url` - document location, `pageNumber` - current page number, `totalPages` - total pages in the document.",
      optional: true,
    },
    height: {
      type: "string",
      label: "Height",
      description: "Sets the height of paper. You can pass in a number or a string with a unit.",
      optional: true,
    },
    landscape: {
      type: "boolean",
      label: "Landscape",
      description: "Whether to print in landscape orientation.",
      optional: true,
      default: false,
    },
    marginBottom: {
      type: "string",
      label: "Bottom Margin",
      description: "Margin for the bottom of the page",
      optional: true,
    },
    marginLeft: {
      type: "string",
      label: "Left Margin",
      description: "Margin for the left side of the page",
      optional: true,
    },
    marginRight: {
      type: "string",
      label: "Right Margin",
      description: "Margin for the right side of the page",
      optional: true,
    },
    marginTop: {
      type: "string",
      label: "Top Margin",
      description: "Margin for the top of the page",
      optional: true,
    },
    omitBackground: {
      type: "boolean",
      label: "Omit Background",
      description: "Hides default white background and allows generating pdfs with transparency.",
      optional: true,
      default: false,
    },
    pageRanges: {
      type: "string",
      label: "Page Ranges",
      description: "Paper ranges to print, e.g. 1-5, 8, 11-13.",
      optional: true,
    },
    preferCSSPageSize: {
      type: "boolean",
      label: "Prefer CSS Page Size",
      description: "Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.",
      optional: true,
      default: false,
    },
    printBackground: {
      type: "boolean",
      label: "Print Background",
      description: "Set to true to print background graphics.",
      optional: true,
      default: false,
    },
    scale: {
      type: "string",
      label: "Scale",
      description: "Scales the rendering of the web page. Amount must be between 0.1 and 2.",
      optional: true,
    },
    timeout: {
      type: "integer",
      label: "Timeout",
      description: "Timeout in milliseconds. Pass 0 to disable timeout.",
      optional: true,
      default: 30000,
    },
    width: {
      type: "string",
      label: "Width",
      description: "Sets the width of paper. You can pass in a number or a string with a unit.",
      optional: true,
    },
  },
  methods: {
    async downloadToTMP(pdf) {
      const path = this.downloadPath.includes("/tmp")
        ? this.downloadPath
        : `/tmp/${this.downloadPath}`;
      fs.writeFileSync(path, pdf);
      return path;
    },
  },
  async run({ $ }) {
    const options = {
      displayHeaderFooter: this.displayHeaderFooter,
      footerTemplate: this.footerTemplate,
      format: this.format,
      headerTemplate: this.headerTemplate,
      height: this.height,
      landscape: this.landscape,
      margin: {
        bottom: this.marginBottom,
        left: this.marginLeft,
        right: this.marginRight,
        top: this.marginTop,
      },
      omitBackground: this.omitBackground,
      pageRanges: this.pageRanges,
      preferCSSPageSize: this.preferCSSPageSize,
      printBackground: this.printBackground,
      scale: this.scale
        ? parseFloat(this.scale)
        : undefined,
      timeout: this.timeout,
      width: this.width,
    };

    const browser = await this.puppeteer.launch();
    const page = await browser.newPage();
    await page.goto(this.url);
    const pdf = await page.pdf(options);
    await browser.close();

    const filePath = pdf && this.downloadPath
      ? await this.downloadToTMP(pdf)
      : undefined;

    if (pdf) {
      $.export("$summary", "Successfully generated PDF from page.");
    }

    return filePath
      ? {
        pdf,
        filePath,
      }
      : pdf;
  },
};

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
Puppeteer	`puppeteer`	`app`	This component uses the Puppeteer app.
URL	`url`	`string`	The URL of the page to scrape.
Download Path	`downloadPath`	`string`	Download the PDF to the `/tmp` directory with the specified filename
Display Header Footer	`displayHeaderFooter`	`boolean`	Whether to show the header and footer.
Footer Template	`footerTemplate`	`string`	HTML template for the print footer.
Format	`format`	`string`	Select a value from the drop down menu:`{ "value": "letter", "label": "Letter - 8.5in x 11in" }{ "value": "legal", "label": "Legal - 8.5in x 14in" }{ "value": "tabloid", "label": "Tabloid - 11in x 17in" }{ "value": "ledger", "label": "Ledger - 17in x 11in" }{ "value": "a0", "label": "A0 - 33.1in x 46.8in" }{ "value": "a1", "label": "A1 - 23.4in x 33.1in" }{ "value": "a2", "label": "A2 - 16.54in x 23.4in" }{ "value": "a3", "label": "A3 - 11.7in x 16.54in" }{ "value": "a4", "label": "A4 - 8.27in x 11.7in" }{ "value": "a5", "label": "A5 - 5.83in x 8.27in" }{ "value": "a6", "label": "A6 - 4.13in x 5.83in" }`
Header Template	`headerTemplate`	`string`	HTML template for the print header. Should be valid HTML with the following classes used to inject values into them: `date` - formatted print date, `title` - document title, `url` - document location, `pageNumber` - current page number, `totalPages` - total pages in the document.
Height	`height`	`string`	Sets the height of paper. You can pass in a number or a string with a unit.
Landscape	`landscape`	`boolean`	Whether to print in landscape orientation.
Bottom Margin	`marginBottom`	`string`	Margin for the bottom of the page
Left Margin	`marginLeft`	`string`	Margin for the left side of the page
Right Margin	`marginRight`	`string`	Margin for the right side of the page
Top Margin	`marginTop`	`string`	Margin for the top of the page
Omit Background	`omitBackground`	`boolean`	Hides default white background and allows generating pdfs with transparency.
Page Ranges	`pageRanges`	`string`	Paper ranges to print, e.g. 1-5, 8, 11-13.
Prefer CSS Page Size	`preferCSSPageSize`	`boolean`	Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.
Print Background	`printBackground`	`boolean`	Set to true to print background graphics.
Scale	`scale`	`string`	Scales the rendering of the web page. Amount must be between 0.1 and 2.
Timeout	`timeout`	`integer`	Timeout in milliseconds. Pass 0 to disable timeout.
Width	`width`	`string`	Sets the width of paper. You can pass in a number or a string with a unit.

Get PDF with Puppeteer API on New Message In Channels (Instant) from Slack API

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

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

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