Publish Message with Ably API on New Segment Entry from Refiner API

Pipedream makes it easy to connect APIs for Ably, Refiner and 2,700+ other apps remarkably fast.

Trigger workflow on

New Segment Entry from the Refiner API

Next, do this

Publish Message with the Ably 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 Refiner trigger and Ably action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Segment Entry trigger
1. Connect your Refiner account
2. Configure timer
3. Select a Segment ID
Configure the Publish Message action
1. Connect your Ably account
2. Configure Channel Name
3. Configure Event Name
4. Configure Message Data
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 Segment Entry on Refiner

Description:Emit new event whenever a user enters a segment in Refiner. [See the documentation](https://refiner.io/docs/api/#get-contacts)

Version:0.0.1

Key:refiner-new-segment-entry

View on GitHub

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "refiner-new-segment-entry",
  name: "New Segment Entry",
  description: "Emit new event whenever a user enters a segment in Refiner. [See the documentation](https://refiner.io/docs/api/#get-contacts)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    segmentId: {
      propDefinition: [
        common.props.refiner,
        "segmentId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getFunction() {
      return this.refiner.listContacts;
    },
    getParams() {
      return {
        segment_uuid: this.segmentId,
      };
    },
    getSummary(item) {
      return `User ${item.email} entered segment ${this.segmentId}`;
    },
    getItemDate(item) {
      return item.segments
        .filter(({ uuid }) => uuid === this.segmentId)[0].created_at;
    },
  },
  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
Refiner	`refiner`	`app`	This component uses the Refiner app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Segment ID	`segmentId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About Refiner#

Customer Feedback Surveys for SaaS & Digital Products

Action#

Publish Message on Ably

Description:Publish a message in a channel. [See docs here](https://ably.com/docs/realtime/messages#message-publish)

Version:0.0.1

Key:ably-publish-message

View on GitHub

Ably Overview#

Ably API provides a platform for adding real-time messaging, streaming, and presence capabilities to your apps. With Pipedream, you can harness this power to create dynamic, event-driven workflows. Automate notifications, synchronize data across systems in real time, or react to Ably events to trigger actions in other services, like sending emails, updating databases, or calling external APIs.

Action Code#

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

export default {
  name: "Publish Message",
  version: "0.0.1",
  key: "ably-publish-message",
  description: "Publish a message in a channel. [See docs here](https://ably.com/docs/realtime/messages#message-publish)",
  type: "action",
  props: {
    ably,
    channelName: {
      propDefinition: [
        ably,
        "channelName",
      ],
      description: "The name of channel that will be published",
    },
    eventName: {
      propDefinition: [
        ably,
        "eventName",
      ],
      description: "The event name that will be published",
    },
    messageData: {
      propDefinition: [
        ably,
        "messageData",
      ],
      description: "The data of the message that will be published",
    },
  },
  async run({ $ }) {
    const response = await this.ably.publishMessage({
      $,
      channelName: this.channelName,
      data: {
        name: this.eventName,
        data: this.messageData,
      },
    });

    if (response.messageId) {
      $.export("$summary", `Successfully published message with ID ${response.messageId}`);
    }

    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
Ably	`ably`	`app`	This component uses the Ably app.
Channel Name	`channelName`	`string`	The name of channel that will be published
Event Name	`eventName`	`string`	The event name that will be published
Message Data	`messageData`	`string`	The data of the message that will be published

Action Authentication#

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

The full application key string can obtained through the dashboard and split at the colon.
api_key_initial is the initial segment of the api key before the colon used as the user name
api_key_remaining is the remaining string (without the leading colon) used as the password.