Validate Webhook Auth with HTTP / Webhook API on New or Removed Documents in a Collection from Fauna API

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

Trigger workflow on

New or Removed Documents in a Collection from the Fauna 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 Fauna 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 or Removed Documents in a Collection trigger
1. Configure timer
2. Connect your Fauna account
3. Select a Collection
4. Optional- Configure Emit changes as a single event
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 or Removed Documents in a Collection on Fauna

Description:Emit new event each time you add or remove a document from a specific collection, with the details of the document.

Version:0.0.8

Key:faunadb-changes-to-collection

View on GitHub

Fauna Overview#

Fauna API offers a powerful serverless database solution for modern applications. Its unique capabilities allow for highly scalable, secure, and flexible data management. With Pipedream, you can harness the power of Fauna to create intricate serverless workflows that react to various triggers, manage data efficiently, and connect seamlessly with other services and APIs to automate complex tasks.

Trigger Code#

import fauna from "../../faunadb.app.mjs";
import _ from "lodash";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  type: "source",
  key: "faunadb-changes-to-collection",
  name: "New or Removed Documents in a Collection",
  description: "Emit new event each time you add or remove a document from a specific collection, with the details of the document.",
  version: "0.0.8",
  dedupe: "unique", // Dedupe events based on the concatenation of event + document ref id
  props: {
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    db: "$.service.db",
    fauna,
    collection: {
      propDefinition: [
        fauna,
        "collections",
      ],
    },
    emitEventsInBatch: {
      type: "boolean",
      label: "Emit changes as a single event",
      description:
        "If `true`, all events are emitted as an array, within a single Pipedream event. Defaults to `false`, emitting each event in Fauna as its own event in Pipedream",
      optional: true,
      default: false,
    },
  },
  async run() {
    // As soon as the script runs, mark the start time so we can fetch changes
    // since this time on the next run. Fauna expects epoch ms as its cursor.
    const ts = +new Date() * 1000;
    const cursor = this.db.get("cursor") || ts;

    const events = await this.fauna.getEventsInCollectionAfterTs(
      this.collection,
      cursor,
    );

    if (!events.length) {
      console.log(`No new events in collection ${this.collection}`);
      this.db.set("cursor", ts);
      return;
    }

    console.log(`${events.length} new events in collection ${this.collection}`);

    // Batched emits do not take advantage of the built-in deduper
    if (this.emitEventsInBatch) {
      this.$emit({
        events,
      }, {
        summary: `${events.length} new event${events.length > 1
          ? "s"
          : ""}`,
        id: cursor,
      });
    } else {
      for (const event of events) {
        this.$emit(event, {
          summary: `${event.action.toUpperCase()} - ${event.document.id}`,
          id: `${event.action}-${event.document.id}`, // dedupes events based on this ID
        });
      }
    }

    // Finally, set cursor for the next run to the max timestamp of the changed events, ensuring we
    // get all events after that on the next run. We need to add 1 since the timestamp filter in
    // Fauna is inclusive: https://docs.fauna.com/fauna/current/api/fql/functions/paginate
    const maxEventTs = _.maxBy(events, (event) => event.ts).ts + 1;

    this.db.set("cursor", maxEventTs);
  },
};

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
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Fauna	`fauna`	`app`	This component uses the Fauna app.
Collection	`collection`	`string`	Select a value from the drop down menu.
Emit changes as a single event	`emitEventsInBatch`	`boolean`	If `true`, all events are emitted as an array, within a single Pipedream event. Defaults to `false`, emitting each event in Fauna as its own event in Pipedream

Trigger Authentication#

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

Create a key in the Security section of your FaunaDB dashboard, then enter the Secret below.

About Fauna#

The distributed serverless database combining the flexibility of NoSQL with the relational querying capabilities of SQL systems.

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

Other Popular Integrations#

Send any HTTP Request with HTTP / Webhook API on New or Removed Documents in a Collection from Fauna API

Fauna + HTTP / Webhook

Try it

Send GET Request with HTTP / Webhook API on New or Removed Documents in a Collection from Fauna API

Fauna + HTTP / Webhook

Try it

Send POST Request with HTTP / Webhook API on New or Removed Documents in a Collection from Fauna API

Fauna + HTTP / Webhook

Try it

Send PUT Request with HTTP / Webhook API on New or Removed Documents in a Collection from Fauna API

Fauna + HTTP / Webhook

Try it

Return HTTP Response with HTTP / Webhook API on New or Removed Documents in a Collection from Fauna API

Fauna + HTTP / Webhook

Try it

Popular Triggers#

New or Removed Documents in a Collection from the Fauna API

Emit new event each time you add or remove a document from a specific collection, with the details of the document.

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