Ongage Subscribe with Ongage API on New Direct Message (Instant) from Slack API

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

Trigger workflow on

New Direct Message (Instant) from the Slack API

Next, do this

Ongage Subscribe with the Ongage 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 Ongage 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 Ongage Subscribe action
1. Connect your Ongage account
2. Optional- Select a List ID
3. Configure Email Address
4. Optional- Configure List Fields
5. Configure Overwrite?
6. Configure Halt on error?
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#

Ongage Subscribe on Ongage

Description:Subscribe to a list in Ongage.

Version:0.0.2

Key:ongage-subscribe

View on GitHub

Ongage Overview#

The Ongage API provides a robust platform for email marketing campaign management, allowing for the creation, management, and analysis of email campaigns. With Pipedream's capabilities, you can automate tasks like syncing subscriber lists, triggering email campaigns based on specific events, and analyzing campaign performance directly within your workflow.

Action Code#

const ongage = require("../../ongage.app.js");

module.exports = {
  key: "ongage-subscribe",
  name: "Ongage Subscribe",
  description: "Subscribe to a list in Ongage.",
  version: "0.0.2",
  type: "action",
  props: {
    ongage,
    listId: {
      propDefinition: [
        ongage,
        "listId",
      ],
      optional: true,
    },
    email: {
      propDefinition: [
        ongage,
        "email",
      ],
    },
    fields: {
      propDefinition: [
        ongage,
        "fields",
      ],
      optional: true,
    },
    overwrite: {
      propDefinition: [
        ongage,
        "overwrite",
      ],
    },
    haltOnError: {
      propDefinition: [
        ongage,
        "haltOnError",
      ],
    },
  },
  async run () {
    try {
      return await this.ongage.subscribe(
        this.listId,
        this.email,
        this.fields,
        this.overwrite,
      );
    } catch (err) {
      if (this.haltOnError) {
        throw err;
      }
      if (err.response) {
        return err.response.data;
      }
      return err;
    }
  },
};

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
Ongage	`ongage`	`app`	This component uses the Ongage app.
List ID	`listId`	`string`	Select a value from the drop down menu.
Email Address	`email`	`string`
List Fields	`fields`	`object`
Overwrite?	`overwrite`	`boolean`	Whether to overwrite the specified fields if the subscriber already exists. Only the fields specified will be overwritten. For more information, see the Ongage API documentation
Halt on error?	`haltOnError`	`boolean`

Action Authentication#

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

Connect to your Ongage account using the Username and Password of the Ongage User who will be using and issuing the API commands, along with your Account Code, that you can find under the Account Profile. See docs.

x_username: your_ongage_username
x_password: your_ongage_password
x_account_code: your_ongage_account_code

Ongage Subscribe with Ongage API on New Direct Message (Instant) from Slack API

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