DynamoDB - Query with AWS API on New Webhook Event (Instant) from Heroku API

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

Trigger workflow on

New Webhook Event (Instant) from the Heroku API

Next, do this

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

Select this integration
Configure the New Webhook Event (Instant) trigger
1. Connect your Heroku account
2. Select a App ID
3. Select one or more Entities
Configure the DynamoDB - Query action
1. Connect your AWS account
2. Select a AWS Region
3. Select a Table Name
4. Configure Key Condition Expression
5. Optional- Configure Projection Expression
6. Optional- Configure Expression Attribute Names
7. Optional- Configure Expression Attribute Values
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 Webhook Event (Instant) on Heroku

Description:Emit new event on each webhook event. [See the documentation](https://devcenter.heroku.com/articles/app-webhooks-schema#webhook-create)

Version:0.0.1

Key:heroku-new-webhook-event-instant

View on GitHub

Heroku Overview#

The Heroku API offers programmatic access to Heroku's cloud platform, enabling developers to automate, extend, and integrate their app's lifecycle events with other services. With Pipedream, you can harness the Heroku API for powerful automation, such as managing apps, dynos, add-ons, and configuring scaling operations. Pipedream's ability to connect with multiple services allows for creating complex workflows, such as syncing your development pipeline with external project management tools or triggering alerts based on app metrics.

Trigger Code#

import heroku from "../../heroku.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "heroku-new-webhook-event-instant",
  name: "New Webhook Event (Instant)",
  description: "Emit new event on each webhook event. [See the documentation](https://devcenter.heroku.com/articles/app-webhooks-schema#webhook-create)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    heroku,
    http: "$.interface.http",
    db: "$.service.db",
    appId: {
      propDefinition: [
        heroku,
        "appId",
      ],
    },
    entities: {
      propDefinition: [
        heroku,
        "entities",
      ],
    },
  },
  hooks: {
    async activate() {
      const { id } = await this.heroku.createWebhookSubscription({
        appId: this.appId,
        data: {
          include: this.entities,
          level: "notify",
          url: this.http.endpoint,
        },
      });
      this._setHookId(id);
    },
    async deactivate() {
      const hookId = this._getHookId();
      if (hookId) {
        await this.heroku.deleteWebhookSubscription({
          appId: this.appId,
          hookId,
        });
      }
    },
  },
  methods: {
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    generateMeta(event) {
      return {
        id: event.id,
        summary: `New ${event.webhook_metadata.event.include} - ${event.action} Event`,
        ts: Date.now(),
      };
    },
  },
  async run(event) {
    const { body } = event;
    if (!body) {
      return;
    }
    const meta = this.generateMeta(body);
    this.$emit(body, meta);
  },
  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
Heroku	`heroku`	`app`	This component uses the Heroku app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
App ID	`appId`	`string`	Select a value from the drop down menu.
Entities	`entities`	`string[]`	Select a value from the drop down menu:`{ "value": "api:addon-attachment", "label": "addon-attachment - An add-on has been attached or removed from the app" }{ "value": "api:addon", "label": "addon - An add-on for the app has been newly provisioned or deleted, or its details have been modified" }{ "value": "api:app", "label": "app - The app itself has been provisioned or deleted, or its details have been modified" }{ "value": "api:build", "label": "build - A new build for the app has been initiated or the build’s status has changed since the last notification" }{ "value": "api:collaborator", "label": "collaborator - A collaborator has been added or removed from the app, or an existing collaborator’s details have been modified" }{ "value": "api:domain", "label": "domain - Custom domain details have been added or removed from the app" }{ "value": "api:dyno", "label": "dyno - A new dyno has begun running for the app" }{ "value": "api:formation", "label": "formation - The dyno formation for a particular process type has been modified" }{ "value": "api:release", "label": "release - A new release for the app has been initiated or the release’s status has changed since the last notification" }{ "value": "api:sni-endpoint", "label": "sni-endpoint - An SNI endpoint has been specified or removed for the app, or the existing SNI endpoint’s details have been modified" }`

Trigger Authentication#

Heroku uses OAuth authentication. When you connect your Heroku account, Pipedream will open a popup window where you can sign into Heroku and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Heroku API.

Pipedream requests the following authorization scopes when you connect your account:

global

About Heroku#

Cloud infrastructure

Action#

DynamoDB - Query on AWS

Description:The query operation finds items based on primary key values. [See docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/classes/querycommand.html)

Version:0.5.1

Key:aws-dynamodb-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.

Action Code#

import common from "../../common/common-dynamodb.mjs";
import {
  toSingleLineString,
  attemptToParseJSON,
} from "../../common/utils.mjs";

export default {
  ...common,
  key: "aws-dynamodb-query",
  name: "DynamoDB - Query",
  description: toSingleLineString(`
    The query operation finds items based on primary key values.
    [See docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/classes/querycommand.html)
  `),
  version: "0.5.1",
  type: "action",
  props: {
    aws: common.props.aws,
    region: common.props.region,
    tableName: common.props.tableName,
    keyConditionExpression: common.props.keyConditionExpression,
    projectionExpression: common.props.projectionExpression,
    expressionAttributeNames: common.props.expressionAttributeNames,
    expressionAttributeValues: common.props.expressionAttributeValues,
  },
  async run({ $ }) {
    const params = {
      TableName: this.tableName,
      KeyConditionExpression: this.keyConditionExpression,
      ProjectionExpression: this.projectionExpression,
      ExpressionAttributeNames: attemptToParseJSON(this.expressionAttributeNames),
      ExpressionAttributeValues: attemptToParseJSON(this.expressionAttributeValues),
    };

    const response = await this.aws.pagination(
      this.query,
      params,
      "ExclusiveStartKey",
      "LastEvaluatedKey",
    );

    const s = response.Items.length === 1
      ? ""
      : "s";
    $.export("$summary", `Query returned ${response.Items.length} item${s}`);
    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
AWS	`aws`	`app`	This component uses the AWS app.
AWS Region	`region`	`string`	Select a value from the drop down menu.
Table Name	`tableName`	`string`	Select a value from the drop down menu.
Key Condition Expression	`keyConditionExpression`	`string`	The condition that specifies the key values for items to be retrieved by the Query action. Example: `partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval` See the docs
Projection Expression	`projectionExpression`	`string`	A string that identifies one or more attributes to retrieve from the specified table or index. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Expression Attribute Names	`expressionAttributeNames`	`string`	One or more substitution tokens for attribute names in an expression. Example: `{ "#execs": "execs" }` See the docs
Expression Attribute Values	`expressionAttributeValues`	`string`	One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. Example: `{ ":echo": { "S": "echo" }, ":oneh": { "N": "100" } }` See the docs

Action 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.

More Ways to Connect AWS + Heroku#

Other Popular Integrations#

CloudWatch Logs - Put Log Event with AWS API on New Webhook Event (Instant) from Heroku API

Heroku + AWS

DynamoDB - Query with AWS API on New Webhook Event (Instant) from Heroku API

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