DynamoDB - Query with AWS API on New Submission from SurveyCTO API

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

Trigger workflow on

New Submission from the SurveyCTO 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 SurveyCTO 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 Submission trigger
1. Connect your SurveyCTO account
2. Configure timer
3. Select a Form ID
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 Submission on SurveyCTO

Description:Emit new event each time a new form submission is received in SurveyCTO. [See the documentation](https://support.surveycto.com/hc/en-us/articles/360033156894-REST-API-documentation). Note: The [role](https://docs.surveycto.com/04-monitoring-and-management/01-the-basics/00b.managing-user-roles.html) of the authenticated user must "Allow server API access".

Version:0.0.1

Key:surveycto-new-submission

View on GitHub

SurveyCTO Overview#

The SurveyCTO API enables automated interactions with SurveyCTO services, a platform focusing on data collection and organization for research and survey projects. With this API, you can seamlessly retrieve, push, and manage survey data. Integrating SurveyCTO with Pipedream opens a realm of possibilities for automating data workflows, such as triggering actions based on new survey submissions, syncing collected data with other databases or apps, or even automating reports and notifications.

Trigger Code#

import surveycto from "../../surveycto.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import sampleEmit from "./test-event.mjs";

export default {
  key: "surveycto-new-submission",
  name: "New Submission",
  description: "Emit new event each time a new form submission is received in SurveyCTO. [See the documentation](https://support.surveycto.com/hc/en-us/articles/360033156894-REST-API-documentation). Note: The [role](https://docs.surveycto.com/04-monitoring-and-management/01-the-basics/00b.managing-user-roles.html) of the authenticated user must \"Allow server API access\".",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    surveycto,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    formId: {
      propDefinition: [
        surveycto,
        "formId",
      ],
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs") || 0;
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    generateMeta(submission) {
      return {
        id: submission.KEY,
        summary: `New Submission ${submission.KEY}`,
        ts: Date.parse(submission.SubmissionDate),
      };
    },
  },
  async run() {
    const lastTs = this._getLastTs();
    let maxTs = lastTs;
    const submissions = await this.surveycto.listSubmissions({
      formId: this.formId,
      params: {
        date: lastTs,
      },
    });
    for (const submission of submissions) {
      const ts = Date.parse(submission.SubmissionDate);
      if (ts > lastTs) {
        const meta = this.generateMeta(submission); console.log(meta);
        this.$emit(submission, meta);
        if (ts > maxTs) {
          maxTs = ts;
        }
      }
    }
    this._setLastTs(maxTs);
  },
  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
SurveyCTO	`surveycto`	`app`	This component uses the SurveyCTO app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Form ID	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

SurveyCTO requires their users enter their SurveyCTO email and password in order to connect to their API. For more info, refer to SurveyCTO, documentation.

In addition, you need to enable API Access in order to connect successfully.

On SurveyCTO Web UI, access Configure tab.
On the Configure tab, scroll down to User roles and permissions section.
Under Administrator (full access, plus subscription management) role, click Edit, then check Allow server API access.

About SurveyCTO#

SurveyCTO is the most reliable, secure, and scalable mobile data collection platform for researchers and professionals working in offline settings.

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 + SurveyCTO#

Other Popular Integrations#

CloudWatch Logs - Put Log Event with AWS API on New Submission from SurveyCTO API

SurveyCTO + AWS

DynamoDB - Query with AWS API on New Submission from SurveyCTO API

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