Update Contact with Heyy API on New Records Returned by CloudWatch Logs Insights Query from AWS API

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

Trigger workflow on

New Records Returned by CloudWatch Logs Insights Query from the AWS API

Next, do this

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

Select this integration
Configure the New Records Returned by CloudWatch Logs Insights Query trigger
1. Connect your AWS account
2. Select a AWS Region
3. Select one or more CloudWatch Log Groups
4. Configure Logs Insights Query
5. Optional- Configure Emit query results as a single event
6. Configure Polling schedule
Configure the Update Contact action
1. Connect your Heyy account
2. Select a Contact ID
3. Optional- Configure Phone Number
4. Optional- Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Email
7. Optional- Select one or more Labels
8. Optional- Configure Attributes
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 Records Returned by CloudWatch Logs Insights Query on AWS

Description:Executes a CloudWatch Logs Insights query on a schedule, and emits the records as invidual events (default) or in batch

Version:0.2.2

Key:aws-new-records-returned-by-cloudwatch-logs-insights-query

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 common from "../../common/common-cloudwatch-logs.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  ...common,
  key: "aws-new-records-returned-by-cloudwatch-logs-insights-query",
  name: "New Records Returned by CloudWatch Logs Insights Query",
  // eslint-disable-next-line pipedream/source-description
  description: "Executes a CloudWatch Logs Insights query on a schedule, and emits the records as invidual events (default) or in batch",
  version: "0.2.2",
  type: "source",
  props: {
    aws: common.props.aws,
    region: common.props.region,
    db: "$.service.db",
    // eslint-disable-next-line pipedream/props-label
    logGroupNames: {
      ...common.props.logGroupName,
      type: "string[]",
      description: "The log groups you'd like to query",
    },
    queryString: {
      label: "Logs Insights Query",
      description: "The query you'd like to run. See [this AWS doc](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) for help with query syntax",
      type: "string",
    },
    emitResultsInBatch: {
      type: "boolean",
      label: "Emit query results as a single event",
      description: "If `true`, all events are emitted as an array, within a single Pipedream event. If `false`, each row of results is emitted as its own event. Defaults to `true`",
      optional: true,
      default: true,
    },
    timer: {
      label: "Polling schedule",
      description: "How often you want to query CloudWatch Logs Insights for results",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  async run() {
    const now = +new Date();
    const startTime = this.db.get("startTime") || now - 1000 * 60 * 60;

    // First, start the query
    const params = {
      queryString: this.queryString,
      startTime,
      endTime: now,
      logGroupNames: this.logGroupNames,
    };

    const { queryId } = await this.startQuery(params);

    // Then poll for its status, emitting each record as its own event when completed
    async function sleep(ms) {
      return new Promise((r) => setTimeout(r, ms));
    }

    let result, res;
    do {
      await sleep(1000);
      res = await this.getQueryResults({
        queryId,
      });
      result = res.status;
    } while (result === "Running" || result === "Scheduled");

    if (result !== "Complete") {
      throw new Error(`Query ${queryId} failed with status ${result}`);
    }

    console.log(JSON.stringify(res, null, 2));
    const { results } = res;

    if (!results || !results.length) {
      console.log("No results, exiting");
      this.db.set("startTime", now);
      return;
    }

    if (this.emitResultsInBatch === true) {
      this.$emit(results, {
        summary: JSON.stringify(results),
      });
    } else {
      for (const item of results) {
        this.$emit(item, {
          summary: JSON.stringify(item),
        });
      }
    }

    // The next time this source runs, query for data starting now
    this.db.set("startTime", now);
  },
};

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.
AWS Region	`region`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
CloudWatch Log Groups	`logGroupNames`	`string[]`	Select a value from the drop down menu.
Logs Insights Query	`queryString`	`string`	The query you'd like to run. See this AWS doc for help with query syntax
Emit query results as a single event	`emitResultsInBatch`	`boolean`	If `true`, all events are emitted as an array, within a single Pipedream event. If `false`, each row of results is emitted as its own event. Defaults to `true`
Polling schedule	`timer`	`$.interface.timer`	How often you want to query CloudWatch Logs Insights for results

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#

Update Contact on Heyy

Description:Updates the details of a contact under your business. [See the documentation](https://documenter.getpostman.com/view/27408936/2sA2r3a6DW#5a5ee22b-c16e-4d46-ae5d-3844b6501a34).

Version:0.0.1

Key:heyy-update-contact

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import app from "../../heyy.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "heyy-update-contact",
  name: "Update Contact",
  description: "Updates the details of a contact under your business. [See the documentation](https://documenter.getpostman.com/view/27408936/2sA2r3a6DW#5a5ee22b-c16e-4d46-ae5d-3844b6501a34).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    contactId: {
      propDefinition: [
        app,
        "contactId",
      ],
    },
    phoneNumber: {
      optional: true,
      propDefinition: [
        app,
        "phoneNumber",
      ],
    },
    firstName: {
      optional: true,
      propDefinition: [
        app,
        "firstName",
      ],
    },
    lastName: {
      propDefinition: [
        app,
        "lastName",
      ],
    },
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    labels: {
      propDefinition: [
        app,
        "labels",
      ],
    },
    attributes: {
      propDefinition: [
        app,
        "attributes",
      ],
    },
  },
  methods: {
    updateContact({
      contactId, ...args
    } = {}) {
      return this.app.put({
        path: `/contacts/${contactId}`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      updateContact,
      contactId,
      phoneNumber,
      firstName,
      lastName,
      email,
      labels,
      attributes,
    } = this;

    if (phoneNumber && !utils.isPhoneNumberValid(phoneNumber)) {
      throw new ConfigurationError(`The phone number \`${phoneNumber}\` is invalid. Please provide a valid phone number.`);
    }

    const response = await updateContact({
      $,
      contactId,
      data: {
        phoneNumber,
        firstName,
        lastName,
        email,
        ...(labels?.length && {
          labels: labels.map((name) => ({
            name,
          })),
        }),
        attributes:
          attributes && Object.entries(attributes)
            .reduce((acc, [
              externalId,
              value,
            ]) => ([
              ...acc,
              {
                externalId,
                value,
              },
            ]), []),
      },
    });

    $.export("$summary", `Successfully updated contact with ID \`${response.data.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
Heyy	`app`	`app`	This component uses the Heyy app.
Contact ID	`contactId`	`string`	Select a value from the drop down menu.
Phone Number	`phoneNumber`	`string`	The phone number of the contact. It must be in E.164 format. Eg: `+14155552671`. For more information please see here.
First Name	`firstName`	`string`	The first name of the contact.
Last Name	`lastName`	`string`	The last name of the contact.
Email	`email`	`string`	The email address of the contact.
Labels	`labels`	`string[]`	Select a value from the drop down menu.
Attributes	`attributes`	`object`	The attributes associated with the contact.

Action Authentication#

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

About Heyy#

Connect with your customers on Whatsapp, SMS, Messenger and Instagram using automation.

More Ways to Connect Heyy + AWS#

Other Popular Integrations#

Update Contact with Heyy API on New DynamoDB Stream Event from AWS API

AWS + Heyy

Update Contact with Heyy API on New Records Returned by CloudWatch Logs Insights Query from AWS API

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