Create Editor Session with CraftMyPDF API on New Direct Message (Instant) from Slack API

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

Trigger workflow on

New Direct Message (Instant) from the Slack API

Next, do this

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

Select this integration
Configure the New Direct Message (Instant) trigger
1. Connect your Slack account
2. Configure slackApphook
3. Optional- Configure Ignore Bots
4. Optional- Configure Ignore Messages from Yourself
Configure the Create Editor Session action
1. Connect your CraftMyPDF account
2. Select a Template Id
3. Configure Expiration (in minutes)
4. Optional- Configure Can Save
5. Optional- Configure Can Create PDF
6. Optional- Configure Can View Settings
7. Optional- Configure Can Preview
8. Optional- Configure Can Edit JSON
9. Optional- Configure Can Show Header
10. Optional- Configure Can Show Layers
11. Optional- Configure Can Show Property Panel
12. Optional- Configure Can Show Help
13. Optional- Configure Can Show Data
14. Optional- Configure Can Show Expression Doc
15. Optional- Configure Can Show Property Binding
16. Optional- Configure Can Show Back URL
17. Optional- Configure JSON Mode
18. Optional- Configure Back URL
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 Direct Message (Instant) on Slack

Description:Emit new event when a message was posted in a direct message channel

Version:1.0.20

Key:slack-new-direct-message

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

export default {
  ...common,
  key: "slack-new-direct-message",
  name: "New Direct Message (Instant)",
  version: "1.0.20",
  description: "Emit new event when a message was posted in a direct message channel",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return [
          "message.im",
        ];
      },
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
    ignoreSelf: {
      type: "boolean",
      label: "Ignore Messages from Yourself",
      description: "Ignores messages sent to yourself",
      default: false,
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New direct message received";
    },
    processEvent(event) {
      if ((this.ignoreSelf && event.user == this.slack.mySlackId())
        || ((this.ignoreBot) && (event.subtype === "bot_message" || event.bot_id))
        || (event.subtype === "message_changed")) {
        return;
      }
      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.
	`slackApphook`	`$.interface.apphook`
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots
Ignore Messages from Yourself	`ignoreSelf`	`boolean`	Ignores messages sent to yourself

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:

channels:historychannels:readchannels:writeemoji:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writereactions:readreactions:writereminders:readreminders:writestars:readteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:userfiles:write:usercommandsusers.profile:writeusers.profile: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#

Create Editor Session on CraftMyPDF

Description:Create a new PDF editor session. The PDF editor url can be embedded into an IFrame. [See the documentation](https://craftmypdf.com/docs/index.html#tag/Template-Management-API/operation/delete-template)

Version:0.0.1

Key:craftmypdf-create-editor-session

View on GitHub

CraftMyPDF Overview#

CraftMyPDF is a powerful API that allows you to create dynamic and customizable PDF documents. By leveraging this API on Pipedream, you can automate the generation of invoices, reports, tickets, and any other document that requires a polished and professional look. Pipedream's serverless platform enables you to connect CraftMyPDF with numerous apps to create workflows that trigger PDF generation from events like form submissions, new database entries, or scheduled jobs.

Action Code#

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

export default {
  key: "craftmypdf-create-editor-session",
  name: "Create Editor Session",
  version: "0.0.1",
  description: "Create a new PDF editor session. The PDF editor url can be embedded into an IFrame. [See the documentation](https://craftmypdf.com/docs/index.html#tag/Template-Management-API/operation/delete-template)",
  type: "action",
  props: {
    craftmypdf,
    templateId: {
      propDefinition: [
        craftmypdf,
        "templateId",
      ],
    },
    expiration: {
      propDefinition: [
        craftmypdf,
        "expiration",
      ],
    },
    canSave: {
      type: "boolean",
      label: "Can Save",
      description: "Can save the template. Default to `true`.",
      optional: true,
    },
    canCreatePDF: {
      type: "boolean",
      label: "Can Create PDF",
      description: "Can Generate PDF. Default to `true`.",
      optional: true,
    },
    canViewSettings: {
      type: "boolean",
      label: "Can View Settings",
      description: "Can view settings. Default to `true`.",
      optional: true,
    },
    canPreview: {
      type: "boolean",
      label: "Can Preview",
      description: "Can preview. Default to `true`.",
      optional: true,
    },
    canEditJSON: {
      type: "boolean",
      label: "Can Edit JSON",
      description: "Can edit JSON. Default to `true`.",
      optional: true,
    },
    canShowHeader: {
      type: "boolean",
      label: "Can Show Header",
      description: "Show CraftMyPDF header. Default to `true`.",
      optional: true,
    },
    canShowLayers: {
      type: "boolean",
      label: "Can Show Layers",
      description: "Show layer dialogue. Default to `true`.",
      optional: true,
    },
    canShowPropertyPanel: {
      type: "boolean",
      label: "Can Show Property Panel",
      description: "Show property panel. Default to `true`.",
      optional: true,
    },
    canShowHelp: {
      type: "boolean",
      label: "Can Show Help",
      description: "Show `Help` tab. Default to `true`.",
      optional: true,
    },
    canShowData: {
      type: "boolean",
      label: "Can Show Data",
      description: "Show `Data` tab. Default to `true`.",
      optional: true,
    },
    canShowExpressionDoc: {
      type: "boolean",
      label: "Can Show Expression Doc",
      description: "Show `Expression Doc` tab. Default to `true`.",
      optional: true,
    },
    canShowPropertyBinding: {
      type: "boolean",
      label: "Can Show Property Binding",
      description: "Show `Property Bind` tab for element. Default to `true`.",
      optional: true,
    },
    canShowBackURL: {
      type: "boolean",
      label: "Can Show Back URL",
      description: "Show `BackURL` button. Default to `true`.",
      optional: true,
    },
    jsonMode: {
      type: "integer",
      label: "JSON Mode",
      description: "JSON editor - `1`, JSON viewer - `2`.",
      optional: true,
    },
    backURL: {
      type: "string",
      label: "Back URL",
      description: "The URL for the back button",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      craftmypdf,
      templateId,
      ...data
    } = this;

    const response = await craftmypdf.createEditorSession({
      $,
      data: {
        ...data,
        template_id: templateId,
      },
    });

    $.export("$summary", "A new editor session was successfully created!");
    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
CraftMyPDF	`craftmypdf`	`app`	This component uses the CraftMyPDF app.
Template Id	`templateId`	`string`	Select a value from the drop down menu.
Expiration (in minutes)	`expiration`	`integer`	Expiration of the generated PDF in minutes. Default to 5 minutes. Range between 1 minute and 24 hours.
Can Save	`canSave`	`boolean`	Can save the template. Default to `true`.
Can Create PDF	`canCreatePDF`	`boolean`	Can Generate PDF. Default to `true`.
Can View Settings	`canViewSettings`	`boolean`	Can view settings. Default to `true`.
Can Preview	`canPreview`	`boolean`	Can preview. Default to `true`.
Can Edit JSON	`canEditJSON`	`boolean`	Can edit JSON. Default to `true`.
Can Show Header	`canShowHeader`	`boolean`	Show CraftMyPDF header. Default to `true`.
Can Show Layers	`canShowLayers`	`boolean`	Show layer dialogue. Default to `true`.
Can Show Property Panel	`canShowPropertyPanel`	`boolean`	Show property panel. Default to `true`.
Can Show Help	`canShowHelp`	`boolean`	Show `Help` tab. Default to `true`.
Can Show Data	`canShowData`	`boolean`	Show `Data` tab. Default to `true`.
Can Show Expression Doc	`canShowExpressionDoc`	`boolean`	Show `Expression Doc` tab. Default to `true`.
Can Show Property Binding	`canShowPropertyBinding`	`boolean`	Show `Property Bind` tab for element. Default to `true`.
Can Show Back URL	`canShowBackURL`	`boolean`	Show `BackURL` button. Default to `true`.
JSON Mode	`jsonMode`	`integer`	JSON editor - `1`, JSON viewer - `2`.
Back URL	`backURL`	`string`	The URL for the back button

Action Authentication#

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

To retrieve your API keys,

Navigate to your CraftMyPDF account and sign in
Grab your API Key directly on the Dashboard under “API Integration”

Create Editor Session with CraftMyPDF API on New Direct Message (Instant) from Slack API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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