Generate Preview with Cardly API on New Direct Message (Instant) from Slack (legacy) API

Pipedream makes it easy to connect APIs for Cardly, Slack (legacy) and 2,900+ other apps remarkably fast.

Trigger workflow on

New Direct Message (Instant) from the Slack (legacy) API

Next, do this

Generate Preview with the Cardly 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 (legacy) trigger and Cardly 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 (legacy) account
2. Configure slackApphook
3. Optional- Configure Ignore Bots
4. Optional- Configure Ignore Messages from Yourself
Configure the Generate Preview action
1. Connect your Cardly account
2. Select a Art
3. Optional- Select a Template
4. Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Company
7. Configure Address
8. Optional- Configure Address 2
9. Configure City
10. Configure Region
11. Configure Country
12. Configure Postcode
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 (legacy)

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

Version:1.0.23

Key:slack-new-direct-message

View on GitHub

Slack (legacy) Overview#

The Pipedream app for Slack enables you to build event-driven workflows that interact with the Slack API. Once you authorize the 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 app for Slack 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.23",
  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 (legacy)	`slack`	`app`	This component uses the Slack (legacy) 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 (legacy) uses OAuth authentication. When you connect your Slack (legacy) account, Pipedream will open a popup window where you can sign into Slack (legacy) 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 (legacy) 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:userfiles:readcommandsusers.profile:writeusers.profile:readsearch:read

About Slack (legacy)#

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#

Generate Preview on Cardly

Description:Generates a preview in Cardly. [See the documentation](https://api.card.ly/v2/docs#endpoint-post-order-preview)

Version:0.0.2

Key:cardly-generate-preview

View on GitHub

Cardly Overview#

The Cardly API empowers you to automate sending personalized cards and gifts to clients, employees, or any recipient with ease. Using Pipedream's serverless platform, you can create workflows that trigger on specific events or conditions, connecting Cardly with other apps to send out physical cards. Automate birthday greetings, thank you notes, holiday cards, or customer follow-ups with handwritten messages, leveraging the power of direct mail in a digital world.

Action Code#

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

export default {
  key: "cardly-generate-preview",
  name: "Generate Preview",
  description: "Generates a preview in Cardly. [See the documentation](https://api.card.ly/v2/docs#endpoint-post-order-preview)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    cardly,
    artId: {
      propDefinition: [
        cardly,
        "artId",
      ],
    },
    templateId: {
      propDefinition: [
        cardly,
        "templateId",
      ],
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The recipient's first name, as it should appear on the envelope.",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The recipient's last name, as it should appear on the envelope.",
      optional: true,
    },
    company: {
      type: "string",
      label: "Company",
      description: "The recipient's company, if required, as it should appear below their name on the envelope.",
      optional: true,
    },
    address: {
      type: "string",
      label: "Address",
      description: "The recipient's street number, name and type.",
    },
    address2: {
      type: "string",
      label: "Address 2",
      description: "Unit, floor, apartment etc. additional information for the recipient's address.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "Suburb or city for the recipient.",
    },
    region: {
      type: "string",
      label: "Region",
      description: "State / province / region for the recipient, if required. UK and NZ currently do not require a region specified. Conditionally required based on the country supplied.",
    },
    country: {
      type: "string",
      label: "Country",
      description: "The 2-character ISO code for the country relating to this recipient.",
    },
    postcode: {
      type: "string",
      label: "Postcode",
      description: "The postcode for this recipient. Note that this may be empty for countries that do not utilise postcodes.",
    },
  },
  async run({ $ }) {
    const { data } = await this.cardly.generatePreview({
      data: {
        artwork: this.artId,
        template: this.templateId,
        recipient: {
          firstName: this.firstName,
          lastName: this.lastName,
          company: this.company,
          address: this.address,
          address2: this.address2,
          city: this.city,
          region: this.region,
          country: this.country,
          postcode: this.postcode,
        },
      },
      $,
    });

    if (data) {
      $.export("summary", "Successully generated preview.");
    }

    return data;
  },
};

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
Cardly	`cardly`	`app`	This component uses the Cardly app.
Art	`artId`	`string`	Select a value from the drop down menu.
Template	`templateId`	`string`	Select a value from the drop down menu.
First Name	`firstName`	`string`	The recipient's first name, as it should appear on the envelope.
Last Name	`lastName`	`string`	The recipient's last name, as it should appear on the envelope.
Company	`company`	`string`	The recipient's company, if required, as it should appear below their name on the envelope.
Address	`address`	`string`	The recipient's street number, name and type.
Address 2	`address2`	`string`	Unit, floor, apartment etc. additional information for the recipient's address.
City	`city`	`string`	Suburb or city for the recipient.
Region	`region`	`string`	State / province / region for the recipient, if required. UK and NZ currently do not require a region specified. Conditionally required based on the country supplied.
Country	`country`	`string`	The 2-character ISO code for the country relating to this recipient.
Postcode	`postcode`	`string`	The postcode for this recipient. Note that this may be empty for countries that do not utilise postcodes.

Generate Preview with Cardly API on New Direct Message (Instant) from Slack (legacy) API

Pipedream makes it easy to connect APIs for Cardly, Slack (legacy) and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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