Send Custom Data with Databox API on New DynamoDB Stream Event from AWS API

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

Trigger workflow on

New DynamoDB Stream Event from the AWS API

Next, do this

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

Select this integration
Configure the New DynamoDB Stream Event trigger
1. Connect your AWS account
2. Configure timer
3. Select a AWS Region
4. Select a Stream
Configure the Send Custom Data action
1. Connect your Databox account
2. Select a Metric Key
3. Configure Value
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 DynamoDB Stream Event on AWS

Description:Emit new event when a DynamoDB stream receives new events. [See the docs here](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetRecords.html)

Version:0.0.2

Key:aws-new-dynamodb-stream-event

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-dynamodb-streams.mjs";

export default {
  ...common,
  key: "aws-new-dynamodb-stream-event",
  name: "New DynamoDB Stream Event",
  description: "Emit new event when a DynamoDB stream receives new events. [See the docs here](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetRecords.html)",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  props: {
    ...common.props,
    stream: {
      type: "string",
      label: "Stream",
      description: "ARN of the Stream to watch for new events",
      async options({ prevContext }) {
        const {
          streams,
          lastEvaluatedStreamArn,
        } = await this.listEnabledStreams({
          ExclusiveStartStreamArn: prevContext.lastEvaluatedStreamArn,
        });
        const options = streams.map((stream) => ({
          label: `${stream.TableName} - Created ${stream.StreamLabel}`,
          value: stream.StreamArn,
        }));
        return {
          options,
          context: {
            lastEvaluatedStreamArn,
          },
        };
      },
    },
  },
  hooks: {
    async deploy() {
      const { StreamDescription: streamDescription } = await this.listShards({
        StreamArn: this.stream,
      });
      const shardId = streamDescription.Shards[streamDescription.Shards.length - 1].ShardId;
      const { ShardIterator: shardIterator } = await this.getShardIterator({
        ShardId: shardId,
        StreamArn: this.stream,
        ShardIteratorType: "LATEST",
      });
      this._setShardIterator(shardIterator);
    },
  },
  methods: {
    ...common.methods,
    _getShardIterator() {
      return this.db.get("shardIterator");
    },
    _setShardIterator(shardIterator) {
      this.db.set("shardIterator", shardIterator);
    },
    generateMeta({
      eventID, eventName, dynamodb,
    }) {
      return {
        id: eventID,
        summary: `New ${eventName} event`,
        ts: Date.parse(dynamodb.ApproximateCreationDateTime),
      };
    },
  },
  async run() {
    if (!(await this.isStreamEnabled(this.stream))) {
      throw new Error("Stream is no longer enabled.");
    }

    const shardIterator = this._getShardIterator();

    const {
      Records: records, NextShardIterator: nextShardIterator,
    } = await this.getRecords({
      ShardIterator: shardIterator,
    });

    for (const record of records) {
      const meta = this.generateMeta(record);
      this.$emit(record, meta);
    }

    this._setShardIterator(nextShardIterator);
  },
};

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.
	`timer`	`$.interface.timer`
AWS Region	`region`	`string`	Select a value from the drop down menu.
Stream	`stream`	`string`	Select a value from the drop down menu.

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#

Send Custom Data on Databox

Description:Sends custom data. [See docs here](https://developers.databox.com/send-data/)

Version:0.0.1

Key:databox-send-custom-data

View on GitHub

Databox Overview#

The Databox API enables you to create custom dashboards, integrating various data sources to track performance metrics in real-time. With Pipedream, you can leverage this API to automate the flow of data between Databox and other applications, creating bespoke monitoring solutions and data-driven workflows that save time and enhance insights.

Action Code#

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

export default {
  name: "Send Custom Data",
  version: "0.0.1",
  key: "databox-send-custom-data",
  description: "Sends custom data. [See docs here](https://developers.databox.com/send-data/)",
  type: "action",
  props: {
    databox,
    metricKey: {
      propDefinition: [
        databox,
        "metricKey",
      ],
    },
    value: {
      label: "Value",
      description: "The value to insert on metric",
      type: "integer",
    },
  },
  async run({ $ }) {
    const response = await this.databox.sendCustomData({
      key: this.metricKey,
      value: this.value,
      date: new Date(),
    });

    if (response.status !== "OK") {
      throw new Error(response.message);
    }

    $.export("$summary", `Successfully pushed data with id ${response.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
Databox	`databox`	`app`	This component uses the Databox app.
Metric Key	`metricKey`	`string`	Select a value from the drop down menu.
Value	`value`	`integer`	The value to insert on metric

Action Authentication#

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

Refer to the Databox documentation to create your token and get started.

About Databox#

Connect your data from any tool and track it from any device. No more logging into dozens of different tools to understand performance — now you and your team can easily connect your data, build and share reports, monitor trends, and discover insights.

More Ways to Connect Databox + AWS#

Other Popular Integrations#

Send Custom Data with Databox API on New Scheduled Tasks from AWS API

AWS + Databox

Send Custom Data with Databox API on New DynamoDB Stream Event from AWS API

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