← FaunaDB + HTTP / Webhook integrations

Custom Request with HTTP / Webhook APIon New or Removed Documents in a Collection from FaunaDB API

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

Trigger workflow on
New or Removed Documents in a Collection from the FaunaDB API
Next, do this
Custom Request with the HTTP / Webhook API
No credit card required
Trusted by 200,000+ developers from startups to Fortune 500 companies:
Trusted by 200,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

This integration creates a workflow with a FaunaDB trigger and HTTP / Webhook action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New or Removed Documents in a Collection trigger
    1. Configure timer
    2. Connect your FaunaDB account
    3. Select a Collection
    4. Optional- Configure Emit changes as a single event
  3. Configure the Custom Request action
    1. Connect your HTTP / Webhook account
    2. Configure URL
    3. Select a Method
    4. Optional- Configure HTTP Body / Payload
    5. Optional- Configure Query Parameters
    6. Optional- Configure HTTP Headers
    7. Optional- Configure Basic Auth
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, open source 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

Description:This source tracks add and remove events to documents in a specific collection. Each time you add or remove a document from this collection, this event source emits an event with the details of the document.
Version:0.0.3
Key:faunadb-changes-to-collection

Trigger Code

const fauna = require("../../faunadb.app.js");
const maxBy = require("lodash.maxby");

module.exports = {
  key: "faunadb-changes-to-collection",
  name: "New or Removed Documents in a Collection",
  description:
    "This source tracks add and remove events to documents in a specific collection. Each time you add or remove a document from this collection, this event source emits an event with the details of the document.",
  version: "0.0.3",
  dedupe: "unique", // Dedupe events based on the concatenation of event + document ref id
  props: {
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: 5 * 60,
      },
    },
    db: "$.service.db",
    fauna,
    collection: {
      propDefinition: [
        fauna,
        "collection",
      ],
    },
    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.instance.id}`,
          id: `${event.action}-${event.instance.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.
LabelPropTypeDescription
timer$.interface.timer
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
FaunaDBfaunaappThis component uses the FaunaDB app.
CollectioncollectionstringSelect a value from the drop down menu.
Emit changes as a single eventemitEventsInBatchboolean

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

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

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

Read more about Keys and Fauna Security.

About FaunaDB

The database built for serverless, featuring native GraphQL

Action

Description:Make an HTTP request using any method and URL. Optionally configure query string parameters, headers and basic auth.
Version:0.1.1
Key:http-custom-request

Action Code

import { axios } from "@pipedream/platform";
import http from "../../http.app.mjs";

export default {
  key: "http-custom-request",
  name: "Custom Request",
  description: "Make an HTTP request using any method and URL. Optionally configure query string parameters, headers and basic auth.",
  type: "action",
  version: "0.1.1",
  props: {
    http,
    url: {
      propDefinition: [
        http,
        "url",
      ],
    },
    method: {
      propDefinition: [
        http,
        "method",
      ],
    },
    data: {
      propDefinition: [
        http,
        "body",
      ],
    },
    params: {
      propDefinition: [
        http,
        "params",
      ],
    },
    headers: {
      propDefinition: [
        http,
        "headers",
      ],
    },
    auth: {
      propDefinition: [
        http,
        "auth",
      ],
    },
  },
  async run({ $ }) {
    const {
      data,
      headers,
      method,
      params,
      url,
    } = this;
    const config = {
      url,
      method,
      data,
      params,
      headers,
    };
    if (this.auth) config.auth = this.http.parseAuth(this.auth);
    return await axios($, config);
  },
}
;

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.

LabelPropTypeDescription
HTTP / WebhookhttpappThis component uses the HTTP / Webhook app.
URLurlstring

The URL you'd like to send the HTTP request to

MethodmethodstringSelect a value from the drop down menu:GETPOSTPUTPATCHDELETEHEADOPTIONS
HTTP Body / Payloaddatastring

The body of the HTTP request. Enter a static value or reference prior step exports via the steps object (e.g., {{steps.foo.$return_value}}).

Query Parametersparamsobject

Add individual query parameters as key-value pairs or disable structured mode to pass multiple key-value pairs as an object.

HTTP Headersheadersobject

Add individual HTTP headers as key-value pairs or disable structured mode to pass multiple key-value pairs as an object.

Basic Authauthstring

To use HTTP basic authentication, enter a username and password separated by | (e.g., myUsername|myPassword).

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 + FaunaDB

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday
Powerful features that scale
Manage concurrency and execution rate
Manage concurrency and execution rate

Queue up to 10,000 events per workfow and manage the concurrency and rate at which workflows are triggered.

Process large payloads up to 5 terabytes
Process large payloads up to 5 terabytes

Large file support enables you to trigger workflows with any data (e.g., large JSON files, images and videos) up to 5 terabytes.

Return custom responses to HTTP requests
Return custom responses to HTTP requests

Return any JSON-serializable response from an HTTP triggered workflow using $respond().

Use most npm packages
Use most npm packages

To use any npm package, just require() it -- there's no npm install or package.json required.

Maintain state between executions
Maintain state between executions

Use $checkpoint to save state in one workflow invocation and read it the next time your workflow runs.

Pass data between steps
Pass data between steps

Return data from any step to inspect it in a human-friendly way and reference the data in future steps via the steps object.