Get Backlinks with Ahrefs API on New Documents from Readwise API

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

Trigger workflow on

New Documents from the Readwise API

Next, do this

Get Backlinks with the Ahrefs API

No credit card required

▶

Watch us build a workflow

8 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 Readwise trigger and Ahrefs action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Documents trigger
1. Connect your Readwise account
2. Configure Polling interval
3. Optional- Select a Location
4. Optional- Select a Category
Configure the Get Backlinks action
1. Connect your Ahrefs account
2. Configure target
3. Optional- Select a mode
4. Optional- Configure limit
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 Documents on Readwise

Description:Emit new document [See the documentation](https://readwise.io/reader_api)

Version:0.0.1

Key:readwise-new-documents

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.

Trigger Code#

import readwise from "../../readwise.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "readwise-new-documents",
  name: "New Documents",
  description: "Emit new document [See the documentation](https://readwise.io/reader_api)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    readwise,
    timer: {
      label: "Polling interval",
      description: "Pipedream polls the Readwise API on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    location: {
      type: "string",
      label: "Location",
      description: "(Optional) The document's location. [See the documentation](https://readwise.io/reader_api).",
      options: ["new", "later", "shortlist", "archive", "feed"],
      optional: true,
    },
    category: {
      type: "string",
      label: "Category",
      description: "(Optional) The document's category. [See the documentation](https://readwise.io/reader_api).",
      options: ["article", "email", "rss", "highlight", "note", "pdf", "epub", "tweet", "video"],
      optional: true,
    },
  },
  hooks: {
    async activate() {
      await this.processEvent();
    },
  },
  methods: {
    async processDocuments(params) {
      const { results: events } = await this.readwise.listDocuments({
        params,
      });
      for (const event of events.slice(0, 100)) {
        this.emitEvent(event);
      }
    },
    async processEvent() {
      await this.processDocuments({
        location: this.location || "",
        category: this.category || "",
      });
    },
    emitEvent(event) {
      this.$emit(event, {
        id: event.id,
        summary: `New Document: ${event.id}`,
        ts: new Date(event.created_at),
      });
    },
  },
  async run() {
    return this.processEvent();
  },
};

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
Readwise	`readwise`	`app`	This component uses the Readwise app.
Polling interval	`timer`	`$.interface.timer`	Pipedream polls the Readwise API on this schedule
Location	`location`	`string`	Select a value from the drop down menu:`newlatershortlistarchivefeed`
Category	`category`	`string`	Select a value from the drop down menu:`articleemailrsshighlightnotepdfepubtweetvideo`

Trigger Authentication#

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

About Readwise#

Readwise makes it easy to revisit and learn from your ebook & article highlights.

Action#

Get Backlinks on Ahrefs

Description:Get the backlinks for a domain or URL with details for the referring pages (e.g., anchor and page title).

Version:0.0.9

Key:ahrefs-get-backlinks

View on GitHub

Ahrefs Overview#

Ahrefs API taps into the vast data reserves of Ahrefs, a robust SEO tool, to programmatically access insights into backlink profiles, keyword rankings, and SEO health. With Pipedream's capabilities, you can automate SEO monitoring, integrate with content management systems, trigger alerts for new or lost backlinks, or gather intelligence for keyword research—all without manual intervention. This unlocks the potential for real-time SEO strategy adjustments and the integration of SEO data into broader business processes or analytics platforms.

Action Code#

const ahrefs = require("../../ahrefs.app.js");
const axios = require("axios");

module.exports = {
  name: "Get Backlinks",
  key: "ahrefs-get-backlinks",
  description: "Get the backlinks for a domain or URL with details for the referring pages (e.g., anchor and page title).",
  version: "0.0.9",
  type: "action",
  props: {
    ahrefs,
    target: {
      propDefinition: [
        ahrefs,
        "target",
      ],
    },
    mode: {
      propDefinition: [
        ahrefs,
        "mode",
      ],
    },
    limit: {
      propDefinition: [
        ahrefs,
        "limit",
      ],
    },
  },
  async run() {
    return (await axios({
      url: "https://apiv2.ahrefs.com",
      params: {
        token: this.ahrefs.$auth.oauth_access_token,
        from: "backlinks",
        target: this.target,
        mode: this.mode,
        limit: this.limit,
        order_by: "ahrefs_rank:desc",
        output: "json",
      },
    })).data;
  },
};

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
Ahrefs	`ahrefs`	`app`	This component uses the Ahrefs app.
target	`target`	`string`	Enter a domain or URL.
mode	`mode`	`string`	Select a value from the drop down menu:`{ "label": "Exact", "value": "exact" }{ "label": "Domain", "value": "domain" }{ "label": "Subdomain", "value": "subdomains" }{ "label": "Prefix", "value": "prefix" }`
limit	`limit`	`integer`	Number of results to return.

Action Authentication#

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

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

api

About Ahrefs#

SEO Tools & Resources

More Ways to Connect Ahrefs + Readwise#

Other Popular Integrations#

Get Backlinks One Per Domain with Ahrefs API on New Highlights from Readwise API

Readwise + Ahrefs

Try it

Get Backlinks with Ahrefs API on New Highlights from Readwise API

Readwise + Ahrefs

Try it

Get Referring Domains with Ahrefs API on New Highlights from Readwise API

Readwise + Ahrefs

Try it

Get Backlinks One Per Domain with Ahrefs API on New Documents from Readwise API

Readwise + Ahrefs

Try it

Get Referring Domains with Ahrefs API on New Documents from Readwise API

Readwise + Ahrefs

Try it

Popular Triggers#

New Documents from the Readwise API

Emit new document See the documentation

Try it

New Highlights from the Readwise API

Emit new Highlight

Try it

Popular Actions#

Get Highlight Details with the Readwise API

Get Highlight´s Details See the docs here

Try it

List Highlights with the Readwise API

A list of highlights with a pagination metadata. The rate limit of this endpoint is restricted to 20 requests per minute. Each request returns 1000 items. See the docs here

Try it

Get Backlinks with the Ahrefs API

Get the backlinks for a domain or URL with details for the referring pages (e.g., anchor and page title).

Try it

Get Backlinks One Per Domain with the Ahrefs API

Get one backlink with the highest ahrefs_rank per referring domain for a target URL or domain (with details for the referring pages including anchor and page title).

Try it

Get Referring Domains with the Ahrefs API

Get the referring domains that contain backlinks to the target URL or domain.

Try it