Get Highlight Details with Readwise API on New Webhook Event from Squarespace API

Pipedream makes it easy to connect APIs for Readwise, Squarespace and 2,000+ other apps remarkably fast.

Trigger workflow on

New Webhook Event from the Squarespace API

Next, do this

Get Highlight Details with the Readwise API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Webhook Event trigger
1. Connect your Squarespace account
2. Select one or more Event Type
Configure the Get Highlight Details action
1. Connect your Readwise account
2. Select a Book Id
3. Select a Highlight Id
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 Webhook Event on Squarespace

Description:Emit new event on each webhook event.

Version:0.0.2

Key:squarespace-new-webhook-event

View on GitHub

Squarespace Overview#

Squarespace's API provides a means to interface programmatically with your Squarespace site, allowing for a plethora of automation opportunities such as manipulating inventory, modifying site content, and syncing data with third-party services. When combined with Pipedream, this can translate into powerful workflows that streamline operations, enhance customer engagement, and keep various platforms in sync with your Squarespace data in real-time.

Trigger Code#

import base from "../common/base.mjs";
import constants from "../common/constants.mjs";

export default {
  ...base,
  name: "New Webhook Event",
  version: "0.0.2",
  key: "squarespace-new-webhook-event",
  description: "Emit new event on each webhook event.",
  type: "source",
  dedupe: "unique",
  props: {
    ...base.props,
    topics: {
      label: "Event Type",
      description: "The type of the event to listen",
      type: "string[]",
      options: constants.WEBHOOK_EVENTS,
    },
  },
  methods: {
    ...base.methods,
    getWebhookEventTypes() {
      return this.topics;
    },
  },
  async run(event) {
    const { body } = event;

    this.$emit(body, {
      id: body.id,
      summary: `New event with id ${body.id}`,
      ts: new Date(),
    });
  },
};

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
Squarespace	`squarespace`	`app`	This component uses the Squarespace app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Event Type	`topics`	`string[]`	Select a value from the drop down menu:`{ "label": "Create Order", "value": "order.create" }{ "label": "Update Order", "value": "order.update" }`

Trigger Authentication#

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

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

website.orderswebsite.orders.readwebsite.transactions.readwebsite.inventorywebsite.inventory.readwebsite.productswebsite.products.read

About Squarespace#

Website Builder

Action#

Get Highlight Details on Readwise

Description:Get Highlight´s Details [See the docs here](https://readwise.io/api_deets)

Version:0.0.3

Key:readwise-get-highlight-details

View on GitHub

Readwise Overview#

The Readwise API allows you to access and manipulate your Readwise data, which includes highlights, notes, and books from your reading list. With this API, you can automate the retrieval of your reading highlights, synchronize them across various platforms, or trigger custom actions based on new highlights added. Pipedream, as a serverless integration and compute platform, enables you to create workflows that leverage the Readwise API to build powerful automations, connecting your reading insights to countless other apps and services to enrich productivity and data management.

Action Code#

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

export default {
  key: "readwise-get-highlight-details",
  name: "Get Highlight Details",
  description: "Get Highlight´s Details [See the docs here](https://readwise.io/api_deets)",
  version: "0.0.3",
  type: "action",
  props: {
    readwise,
    bookId: {
      propDefinition: [
        readwise,
        "bookId",
      ],
    },
    highlightId: {
      propDefinition: [
        readwise,
        "highlightId",
        (c) => ({
          bookId: c.bookId,
        }),
      ],
    },
  },
  async run({ $ }) {
    const highlight = await this.readwise.getHighlight({
      $,
      highlightId: this.highlightId,
    });

    $.export("$summary", `Successfully returned highlight (${this.highlightId})`);
    return highlight;
  },
};

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
Readwise	`readwise`	`app`	This component uses the Readwise app.
Book Id	`bookId`	`integer`	Select a value from the drop down menu.
Highlight Id	`highlightId`	`integer`	Select a value from the drop down menu.