Add Contact to Event with Regal API on New Scheduled Tasks from AWS API

Pipedream makes it easy to connect APIs for Regal, AWS and 2,200+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the AWS API

Next, do this

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

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your AWS account
2. Select a AWS Region
3. Optional- Configure Secret
Configure the Add Contact to Event action
1. Connect your Regal account
2. Configure User ID
3. Optional- Configure Phone
4. Optional- Configure Email
5. Optional- Configure Event Name
6. Optional- Configure Custom Property Name (1)
7. Optional- Configure Custom Property Value (1)
8. Optional- Configure Additional Properties to Add
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 Scheduled Tasks on AWS

Description:Creates a Step Function State Machine to publish a message to an SNS topic at a specific timestamp. The SNS topic delivers the message to this Pipedream source, and the source emits it as a new event.

Version:0.4.2

Key:aws-new-scheduled-tasks

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/scheduled.mjs";
import { toSingleLineString } from "../../common/utils.mjs";

export default {
  ...base,
  key: "aws-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  description: toSingleLineString(`
    Creates a Step Function State Machine to publish a message
    to an SNS topic at a specific timestamp. The SNS topic delivers
    the message to this Pipedream source, and the source emits it as a new event.
  `),
  version: "0.4.2",
  type: "source",
  dedupe: "unique", // Dedupe on SNS message ID
  methods: {
    ...base.methods,
    getStateMachineDefinition() {
      const { PD_COMPONENT: componentId } = process.env;
      const topicArn = this.getTopicArn();
      return {
        Comment: `Task Scheduler for Pipedream component ${componentId}`,
        StartAt: "Wait",
        States: {
          Wait: {
            Comment: "Wait until specified timestamp",
            Type: "Wait",
            TimestampPath: "$.timestamp",
            Next: "SendMessageToSNS",
          },
          SendMessageToSNS: {
            Type: "Task",
            Resource: "arn:aws:states:::sns:publish",
            Parameters: {
              "TopicArn": topicArn,
              "Message.$": "$",
            },
            End: true,
          },
        },
      };
    },
    getStateMachinePermissions() {
      const topicArn = this.getTopicArn();
      const document = {
        Version: "2012-10-17",
        Statement: [
          {
            Effect: "Allow",
            Action: [
              "sns:Publish",
            ],
            Resource: [
              topicArn,
            ],
          },
        ],
      };
      const name = "publish-messages-to-pipedream-sns-topic";
      return {
        document,
        name,
      };
    },
  },
};

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.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `secret` parameter of each HTTP POST request

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.

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

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

Action#

Add Contact to Event on Regal

Description:Add a contact to an event. [See the documentation](https://developer.regal.io/reference/api)

Version:0.0.1

Key:regal-add-contact-to-event

View on GitHub

Action Code#

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

export default {
  key: "regal-add-contact-to-event",
  name: "Add Contact to Event",
  description: "Add a contact to an event. [See the documentation](https://developer.regal.io/reference/api)",
  version: "0.0.1",
  type: "action",
  props: {
    regal,
    userId: {
      propDefinition: [
        regal,
        "userId",
      ],
      optional: false,
    },
    phone: {
      propDefinition: [
        regal,
        "phone",
      ],
    },
    email: {
      propDefinition: [
        regal,
        "email",
      ],
    },
    name: {
      propDefinition: [
        regal,
        "name",
      ],
    },
    customPropertyName1: {
      type: "string",
      label: "Custom Property Name (1)",
      description: "Name of a custom property to add to the event",
      optional: true,
    },
    customPropertyValue1: {
      type: "string",
      label: "Custom Property Value (1)",
      description: "Value of a custom property to add to the event",
      optional: true,
    },
    additionalProperties: {
      type: "integer",
      label: "Additional Properties to Add",
      description: "The number of additional properties to add to the event",
      optional: true,
      reloadProps: true,
    },
  },
  additionalProps() {
    const props = {};
    if (!this.additionalProperties > 0) {
      return props;
    }
    for (let i = 2; i < this.additionalProperties + 2; i++) {
      props[`customPropertyName${i}`] = {
        type: "string",
        label: `Custom Property Name (${i})`,
        description: "Name of a custom property to add to the event",
      };
      props[`customPropertyValue${i}`] = {
        type: "string",
        label: `Custom Property Value (${i})`,
        description: "Value of a custom property to add to the event",
      };
    }
    return props;
  },
  async run({ $ }) {
    const properties = this.customPropertyName1
      ? {
        [this.customPropertyName1]: this.customPropertyValue,
      }
      : {};
    for (let i = 2; i < this.additionalProperties + 2; i++) {
      properties[this[`customPropertyName${i}`]] = this[`customPropertyValue${i}`];
    }

    const response = await this.regal.customEvent({
      $,
      data: {
        userId: this.userId,
        traits: {
          phones: this.phone
            ? {
              [this.phone]: {},
            }
            : undefined,
          emails: this.email
            ? {
              [this.email]: {},
            }
            : undefined,
        },
        name: this.name,
        properties,
      },
    });
    if (response?.message === "ok") {
      $.export("$summary", `Successfully added contact with ID "${this.userId}" to event`);
    }
    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
Regal	`regal`	`app`	This component uses the Regal app.
User ID	`userId`	`string`	Unique identifier for your contact
Phone	`phone`	`string`	Phone number of the contact. Example: `+1 (954) 555-2399`
Email	`email`	`string`	Email address of the contact
Event Name	`name`	`string`	Name of the event
Custom Property Name (1)	`customPropertyName1`	`string`	Name of a custom property to add to the event
Custom Property Value (1)	`customPropertyValue1`	`string`	Value of a custom property to add to the event
Additional Properties to Add	`additionalProperties`	`integer`	The number of additional properties to add to the event

Action Authentication#

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

About Regal#

Outbound Cloud Contact Center Software.

More Ways to Connect Regal + AWS#

Other Popular Integrations#

Create or Update Contact or Event with Regal API on New DynamoDB Stream Event from AWS API

AWS + Regal

Add Contact to Event with Regal API on New Scheduled Tasks from AWS API

Pipedream makes it easy to connect APIs for Regal, AWS and 2,200+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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