Create Location with Deputy API on New DynamoDB Stream Event from AWS API

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

Trigger workflow on

New DynamoDB Stream Event from the AWS API

Next, do this

Create Location with the Deputy 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 Deputy 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 Create Location action
1. Connect your Deputy account
2. Configure Name
3. Configure Address
4. Optional- Select a Parent Company ID
5. Optional- Configure Timezone
6. Optional- Configure Notes
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#

Create Location on Deputy

Description:Creates a new location in Deputy. [See the documentation](https://developer.deputy.com/deputy-docs/reference/addalocation)

Version:0.0.1

Key:deputy-create-location

View on GitHub

Deputy Overview#

Deputy is a robust workforce management tool, catering to scheduling, timesheet tracking, and other employee coordination tasks. Leveraging the Deputy API on Pipedream allows you to automate mundane tasks, sync data across platforms, and create custom notifications based on employee actions. You could build workflows to manage shifts, sync employee details with HR systems, or trigger payroll processes, harnessing Pipedream's capability to integrate with various services without the need for manual coding.

Action Code#

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

export default {
  key: "deputy-create-location",
  name: "Create Location",
  description: "Creates a new location in Deputy. [See the documentation](https://developer.deputy.com/deputy-docs/reference/addalocation)",
  version: "0.0.1",
  type: "action",
  props: {
    deputy,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the workplace",
    },
    address: {
      type: "string",
      label: "Address",
      description: "The address of the workplace",
    },
    parentCompanyId: {
      propDefinition: [
        deputy,
        "locationId",
      ],
      label: "Parent Company ID",
      description: "The identifier of the parent company",
      optional: true,
    },
    timezone: {
      type: "string",
      label: "Timezone",
      description: "The timezone of the workplace. Example: `Australia/Sydney`",
      optional: true,
    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Notes about the location",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.deputy.createLocation({
      $,
      data: {
        strWorkplaceName: this.name,
        strAddress: this.address,
        intParentCompany: this.parentCompanyId,
        strTimezone: this.timezone,
        strAddressNotes: this.notes,
      },
    });
    $.export("$summary", `Successfully created location 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
Deputy	`deputy`	`app`	This component uses the Deputy app.
Name	`name`	`string`	The name of the workplace
Address	`address`	`string`	The address of the workplace
Parent Company ID	`parentCompanyId`	`string`	Select a value from the drop down menu.
Timezone	`timezone`	`string`	The timezone of the workplace. Example: `Australia/Sydney`
Notes	`notes`	`string`	Notes about the location

Action Authentication#

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

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

longlife_refresh_token

About Deputy#

Employee scheduling, timesheets, tasking and communication platform

More Ways to Connect Deputy + AWS#

Other Popular Integrations#

Create Location with Deputy API on New Inbound SES Emails from AWS API

AWS + Deputy

Create Location with Deputy API on New DynamoDB Stream Event from AWS API

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