Validate Webhook Auth with HTTP / Webhook API on New Submission from SurveyCTO API

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

Trigger workflow on

New Submission from the SurveyCTO API

Next, do this

Validate Webhook Auth with the HTTP / Webhook 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 HTTP / Webhook 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 Validate Webhook Auth action
1. Connect your HTTP / Webhook account
2. Configure Authorization Value to Authenticate
3. Configure Return Error to Webhook Caller
4. Select a Authorization Type
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#

Validate Webhook Auth on HTTP / Webhook

Description:Require authorization for incoming HTTP webhook requests. Make sure to configure the HTTP trigger to "Return a custom response from your workflow".

Version:0.0.3

Key:http-validate-webhook-auth

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Action Code#

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

export default {
  name: "Validate Webhook Auth",
  version: "0.0.3",
  key: "http-validate-webhook-auth",
  description: "Require authorization for incoming HTTP webhook requests. Make sure to configure the HTTP trigger to \"Return a custom response from your workflow\".",
  type: "action",
  props: {
    http,
    authInput: {
      type: "string",
      label: "Authorization Value to Authenticate",
      description: "Select the location of the authorization value to check. For example, if you're looking for a Bearer token on the inbound webhook request, set this to `{{steps.trigger.event.body.headers.authorization}}`.",
      default: "{{steps.trigger.event.headers.authorization}}",
    },
    customResponse: {
      type: "boolean",
      label: "Return Error to Webhook Caller",
      description: "If `True`, returns a `401: Invalid credentials` error in the case of invalid authorization. **Make sure to configure the HTTP trigger to \"Return a custom response from your workflow\"**. If `False`, does not return a custom response in the case of invalid auth.",
      default: true,
    },
    authType: {
      type: "string",
      label: "Authorization Type",
      description: "Select the Authorization Type for the incoming webhook.",
      reloadProps: true,
      options: [
        {
          label: "Basic Auth",
          value: "basic",
        },
        {
          label: "Bearer Auth",
          value: "bearer",
        },
        {
          label: "Key-Based Auth",
          value: "key",
        },
      ],
    },
  },
  async additionalProps() {
    const props = {};
    switch (this.authType) {
    case "basic":
      props.basicAuthUsername = {
        type: "string",
        label: "Username",
        description: "Enter your username or reference an environment variable. For example, `{{process.env.username}}`.",
      };
      props.basicAuthPassword = {
        type: "string",
        label: "Password",
        description: "Enter your password or reference an environment variable. For example, `{{process.env.password}}`.",
        secret: true,
      };
      break;
    case "bearer":
      props.bearer = {
        type: "string",
        label: "Bearer Token",
        description: "Enter your Bearer Token  or reference an environment variable. For example, `{{process.env.token}}`. **Make sure to include any prepended values**, like `Bearer` for example.",
      };
      break;
    case "key":
      props.key = {
        type: "string",
        label: "API Key",
        description: "Enter your API Key or reference an environment variable. For example, `{{process.env.api_key}}`.",
        secret: true,
      };
      break;
    default:
    }
    return props;
  },
  async run({ $ }) {
    const authType = this.authType;
    const authInput = this.authInput;
    let basicString = "";
    if (authType === "basic") {
      const un = this.basicAuthUsername;
      const pw = this.basicAuthPassword;
      const str = `${un}:${pw}`;
      const buff = Buffer.from(str, "utf-8");
      basicString = `Basic ${buff.toString("base64")}`;
    }
    const authValue = this.bearer ?? this.key ?? basicString;
    if (authInput !== authValue) {
      if (this.customResponse) {
        await $.respond({
          status: 401,
          headers: {},
          body: "Invalid credentials",
        });
      }
      return $.flow.exit("Invalid credentials");
    }
    $.export("$summary", "HTTP request successfully authenticated");
  },
};

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
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.
Authorization Value to Authenticate	`authInput`	`string`	Select the location of the authorization value to check. For example, if you're looking for a Bearer token on the inbound webhook request, set this to `{{steps.trigger.event.body.headers.authorization}}`.
Return Error to Webhook Caller	`customResponse`	`boolean`	If `True`, returns a `401: Invalid credentials` error in the case of invalid authorization. Make sure to configure the HTTP trigger to "Return a custom response from your workflow". If `False`, does not return a custom response in the case of invalid auth.
Authorization Type	`authType`	`string`	Select a value from the drop down menu:`{ "label": "Basic Auth", "value": "basic" }{ "label": "Bearer Auth", "value": "bearer" }{ "label": "Key-Based Auth", "value": "key" }`

Action Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

More Ways to Connect HTTP / Webhook + SurveyCTO#

Other Popular Integrations#

Send any HTTP Request with HTTP / Webhook API on New Submission from SurveyCTO API

SurveyCTO + HTTP / Webhook

Try it

Send GET Request with HTTP / Webhook API on New Submission from SurveyCTO API

SurveyCTO + HTTP / Webhook

Try it

Send POST Request with HTTP / Webhook API on New Submission from SurveyCTO API

SurveyCTO + HTTP / Webhook

Try it

Send PUT Request with HTTP / Webhook API on New Submission from SurveyCTO API

SurveyCTO + HTTP / Webhook

Try it

Return HTTP Response with HTTP / Webhook API on New Submission from SurveyCTO API

SurveyCTO + HTTP / Webhook

Try it

Popular Triggers#

New Submission from the SurveyCTO API

Emit new event each time a new form submission is received in SurveyCTO. See the documentation. Note: The role of the authenticated user must "Allow server API access".

Try it

New Requests from the HTTP / Webhook API

Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Try it

New Requests (Payload Only) from the HTTP / Webhook API

Get a URL and emit the HTTP body as an event on every request

Try it

New event when the content of the URL changes. from the HTTP / Webhook API

Emit new event when the content of the URL changes.

Try it