Send Survey with AskNicely API on New Message In Channels (Instant) from Slack API

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

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

Send Survey with the AskNicely 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 AskNicely 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 Send Survey action
1. Connect your AskNicely account
2. Configure Email
3. Optional- Configure Name
4. Optional- Configure Trigger Email
5. Optional- Configure Delay Minutes
6. Optional- Configure Segment
7. Optional- Configure Custom Fields
8. Optional- Configure Then Deactivate
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.15

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.15",
  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#

Send Survey on AskNicely

Description:Trigger a survey to a contact. [See the documentation](https://demo.asknice.ly/help/apidocs/survey)

Version:0.0.1

Key:asknicely-send-survey

View on GitHub

AskNicely Overview#

The AskNicely API enables you to tap into customer feedback processes by automating the collection and analysis of customer satisfaction data. With Pipedream, you can leverage this API to create custom workflows that trigger on specific events, interact with other apps, and perform actions based on customer feedback scores and comments. Whether you're syncing data to a CRM, triggering email campaigns based on scores, or aggregating responses for analysis, the API's integration into Pipedream opens a world of possibilities for enhancing customer experience and operational efficiency.

Action Code#

import asknicely from "../../asknicely.app.mjs";
import { clearObj } from "../../common/utils.mjs";

export default {
  key: "asknicely-send-survey",
  name: "Send Survey",
  version: "0.0.1",
  description: "Trigger a survey to a contact. [See the documentation](https://demo.asknice.ly/help/apidocs/survey)",
  type: "action",
  props: {
    asknicely,
    email: {
      propDefinition: [
        asknicely,
        "email",
      ],
    },
    name: {
      propDefinition: [
        asknicely,
        "name",
      ],
      optional: true,
    },
    triggeremail: {
      type: "boolean",
      label: "Trigger Email",
      description: "If set to true, the API will always send a survey, we recommend to only use this parameter for testing the API to see the survey emails being sent. Remove this entirely when in production, as including this parameter will override all contact rules and send a survey for each API call. Setting **false** won't stop it from sending surveys.",
      optional: true,
    },
    delayminutes: {
      type: "integer",
      label: "Delay Minutes",
      description: "If you want to trigger a survey to have a delay, use delayminutes. 10 = 10 minute delay. 7 day delay would be 60*24*7 = 10800, there is no limit to how minutes or days you can delay. This value ignored for sms, surveys are always sent immediately.",
      optional: true,
    },
    segment: {
      propDefinition: [
        asknicely,
        "segment",
      ],
      optional: true,
    },
    customFields: {
      propDefinition: [
        asknicely,
        "customFields",
      ],
      optional: true,
    },
    thendeactivate: {
      type: "boolean",
      label: "Then Deactivate",
      description: "After a survey has been sent, de-activate this customer so they are not eligible for NPS surveys sent via the Daily Scheduler on the Send page. If you wish to de-activate a customer regardless of if a survey is sent or not, please use the [remove contact](https://demo.asknice.ly/help/removecontact) API. `Very handy if you are using both the Daily Scheduler and API calls.`",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      asknicely,
      segment,
      customFields,
      ...params
    } = this;

    const response = await asknicely.sendSurvey(clearObj({
      $,
      params: {
        ...customFields,
        segment,
        ...params,
      },
    }));

    $.export("$summary", "The survey was successfully sent!");
    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
AskNicely	`asknicely`	`app`	This component uses the AskNicely app.
Email	`email`	`string`	The email of the contact.
Name	`name`	`string`	The name of the contact.
Trigger Email	`triggeremail`	`boolean`	If set to true, the API will always send a survey, we recommend to only use this parameter for testing the API to see the survey emails being sent. Remove this entirely when in production, as including this parameter will override all contact rules and send a survey for each API call. Setting false won't stop it from sending surveys.
Delay Minutes	`delayminutes`	`integer`	If you want to trigger a survey to have a delay, use delayminutes. 10 = 10 minute delay. 7 day delay would be 60247 = 10800, there is no limit to how minutes or days you can delay. This value ignored for sms, surveys are always sent immediately.
Segment	`segment`	`string`	Set a customers segments.
Custom Fields	`customFields`	`object`	Add extra argments to send through extra custom data to help identify/filter/leaderboard customers. Multiple arguments can be sent with each request.
Then Deactivate	`thendeactivate`	`boolean`	After a survey has been sent, de-activate this customer so they are not eligible for NPS surveys sent via the Daily Scheduler on the Send page. If you wish to de-activate a customer regardless of if a survey is sent or not, please use the remove contact API. `Very handy if you are using both the Daily Scheduler and API calls.`

Action Authentication#

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

To retrieve your API Key,

Navigate to your AskNicely account and sign in
Go to “Settings” > “Users”
Select your account, then click “Show API Key”

Your domain in 1234 if your AskNicely login portal URL is https://1234.asknice.ly/login/

About AskNicely#

The #1 Rated Customer Experience Platform for Frontline Teams.

More Ways to Connect AskNicely + Slack#

Other Popular Integrations#

Add Contact with AskNicely API on New Star Added To Message (Instant) from Slack API

Slack + AskNicely

Send Survey with AskNicely API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for AskNicely, 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