Create Event with Heartbeat API on New SNS Messages from AWS API

Pipedream makes it easy to connect APIs for Heartbeat, AWS and 3,000+ other apps remarkably fast.

Trigger workflow on

New SNS Messages from the AWS API

Next, do this

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

Select this integration
Configure the New SNS Messages trigger
1. Connect your AWS account
2. Select a AWS Region
3. Optional- Select a SNS Topic
4. Optional- Configure SNS Topic Name
Configure the Create Event action
1. Connect your Heartbeat account
2. Configure Name
3. Optional- Configure Description
4. Configure Start Date & Time
5. Configure Duration
6. Select a Location
7. Optional- Select one or more Invited Users
8. Optional- Select one or more Invited Groups
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 SNS Messages on AWS

Description:Creates an SNS topic in your AWS account. Messages published to this topic are emitted from the Pipedream source.

Version:0.4.3

Key:aws-new-sns-messages

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import base from "../common/sns.mjs";
import { toSingleLineString } from "../../common/utils.mjs";
import commonSNS from "../../common/common-sns.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  ...base,
  key: "aws-new-sns-messages",
  name: "New SNS Messages",
  description: toSingleLineString(`
    Creates an SNS topic in your AWS account.
    Messages published to this topic are emitted from the Pipedream source.
  `),
  version: "0.4.3",
  type: "source",
  dedupe: "unique", // Dedupe on SNS message ID
  props: {
    ...base.props,
    topicArn: {
      ...commonSNS.props.topic,
      optional: true,
    },
    topic: {
      label: "SNS Topic Name",
      description: toSingleLineString(`
        **Pipedream will create an SNS topic with this name in your account**,
        converting it to a [valid SNS topic
        name](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html).
      `),
      type: "string",
      optional: true,
    },
  },
  methods: {
    ...base.methods,
    getTopicName() {
      return this.convertNameToValidSNSTopicName(this.topic);
    },
  },
  async run(event) {
    if (!this.topicArn && !this.topic) {
      throw new ConfigurationError("Must specify either an existing topic or a new topic name");
    }

    if (this._isSubscriptionConfirmationEvent(event)) {
      const { body } = event;
      const subscriptionArn = await this._confirmSubscription(body);
      this._setSubscriptionArn(subscriptionArn);
      return;
    }

    await this.processEvent(event);
  },
};

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
AWS	`aws`	`app`	This component uses the AWS app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
AWS Region	`region`	`string`	Select a value from the drop down menu.
SNS Topic	`topicArn`	`string`	Select a value from the drop down menu.
SNS Topic Name	`topic`	`string`	Pipedream will create an SNS topic with this name in your account, converting it to a valid SNS topic name

Trigger Authentication#

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

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Action#

Create Event on Heartbeat

Description:Create a new Event in a Heartbeat community. [See the documentation](https://heartbeat.readme.io/reference/createevent)

Version:0.0.1

Key:heartbeat-create-event

View on GitHub

Heartbeat Overview#

The Heartbeat API offers a powerful way to connect and automate your community engagement. With this API, you can monitor community signals, manage members, and trigger events based on community interactions. By integrating Heartbeat with Pipedream, you can create dynamic, serverless workflows that act upon these signals and bring efficiency to your community management tasks. Whether it's automating welcome messages, syncing member data with other platforms, or analyzing community health, the possibilities are vast.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import heartbeat from "../../heartbeat.app.mjs";

export default {
  key: "heartbeat-create-event",
  name: "Create Event",
  description: "Create a new Event in a Heartbeat community. [See the documentation](https://heartbeat.readme.io/reference/createevent)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    heartbeat,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the event",
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the event",
      optional: true,
    },
    startTime: {
      type: "string",
      label: "Start Date & Time",
      description: "The start date & time of the event. Accepts datetimes in the following formats: `YYYY-MM-DD hh:mm:ss` e.g. 2023-11-28 10:00:00, `YYYY-MM-DD hh:mm` e.g. 2023-11-28 10:00, `YYYY-MM-DD` e.g. 2023-11-28",
    },
    duration: {
      type: "integer",
      label: "Duration",
      description: "The duration of the event in minutes",
    },
    location: {
      type: "string",
      label: "Location",
      description: "Where the event will be held. If the string 'HEARTBEAT' is provided, then the event will take place in a Heartbeat voice channel. If the string 'ZOOM' is provided, then the event will take place in a custom Zoom link (this option can only be chosen if a Zoom account has been integrated with Heartbeat). Otherwise, the provided string will be passed directly to the Custom location field",
      options: [
        "HEARTBEAT",
        "ZOOM",
      ],
    },
    invitedUsers: {
      propDefinition: [
        heartbeat,
        "emails",
      ],
      type: "string[]",
      label: "Invited Users",
      description: "A list of users that should be invited to the event. If the email matches an existing Heartbeat user, the Heartbeat user will be invited. Otherwise, an event invite will be sent directly to the provided email address. If both `Invited Users` & `Invited Groups` are empty, the event will be open to everyone in the community",
      optional: true,
    },
    invitedGroups: {
      propDefinition: [
        heartbeat,
        "groupID",
      ],
      type: "string[]",
      label: "Invited Groups",
      description: "A list of groups that should be invited to the event. If both `Invited Users` and `Invited Groups` are empty, the event will be open to everyone in the community",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.heartbeat.createEvent({
      $,
      data: {
        name: this.name,
        description: this.description,
        startTime: this.startTime,
        duration: this.duration,
        location: this.location,
        invitedUsers: parseObject(this.invitedUsers),
        invitedGroups: parseObject(this.invitedGroups),
      },
    });

    $.export("$summary", `Successfully created event with ID ${response.event.id}.`);
    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
Heartbeat	`heartbeat`	`app`	This component uses the Heartbeat app.
Name	`name`	`string`	The name of the event
Description	`description`	`string`	The description of the event
Start Date & Time	`startTime`	`string`	The start date & time of the event. Accepts datetimes in the following formats: `YYYY-MM-DD hh:mm:ss` e.g. 2023-11-28 10:00:00, `YYYY-MM-DD hh:mm` e.g. 2023-11-28 10:00, `YYYY-MM-DD` e.g. 2023-11-28
Duration	`duration`	`integer`	The duration of the event in minutes
Location	`location`	`string`	Select a value from the drop down menu:`HEARTBEATZOOM`
Invited Users	`invitedUsers`	`string[]`	Select a value from the drop down menu.
Invited Groups	`invitedGroups`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API credentials,

Navigate to your Heartbeat account and sign in
Go to “Settings” > “API Keys”

About Heartbeat#

Plug-and-play online communities.

More Ways to Connect Heartbeat + AWS#

Other Popular Integrations#

Add To Group with Heartbeat API on New DynamoDB Stream Event from AWS API

AWS + Heartbeat

Create Event with Heartbeat API on New SNS Messages from AWS API

Pipedream makes it easy to connect APIs for Heartbeat, AWS and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular