Get Backlinks with Ahrefs API on New Client Created from YoPlanning API

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

Trigger workflow on

New Client Created from the YoPlanning 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 YoPlanning 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 Client Created trigger
1. Connect your YoPlanning account
2. Configure Polling schedule
3. Select a Team ID
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 Client Created on YoPlanning

Description:Triggers when a new client is created. [See the documentation](https://yoplanning.pro/api/v3.1/swagger/)

Version:0.0.4

Key:yoplanning-new-client-created

View on GitHub

YoPlanning Overview#

YoPlanning API offers tools for event planning, with features such as creating and managing event schedules, attendee lists, and budgets. Leveraging this API in Pipedream enables automating event-related workflows, syncing event data with other services, and triggering actions based on event updates or attendee responses. It's a powerful way to streamline event management tasks, ensuring that nothing slips through the cracks as you orchestrate everything from small meetings to large conferences.

Trigger Code#

import common from "../common/polling.mjs";
import utils from "../../common/utils.mjs";

export default {
  ...common,
  key: "yoplanning-new-client-created",
  name: "New Client Created",
  description: "Triggers when a new client is created. [See the documentation](https://yoplanning.pro/api/v3.1/swagger/)",
  type: "source",
  version: "0.0.4",
  dedupe: "unique",
  props: {
    ...common.props,
    teamId: {
      propDefinition: [
        common.props.app,
        "teamId",
      ],
    },
  },
  methods: {
    ...common.methods,
    ordering(resources) {
      return utils.sortArrayByDate(resources, "-last_update");
    },
    getResourceFn() {
      return this.app.listClients;
    },
    getResourceFnArgs() {
      return {
        teamId: this.teamId,
        params: {
          ordering: "-last_update",
          last_update__gt: this.getLastUpdate(),
        },
      };
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `New Client: ${resource.id}`,
        ts: Date.now(),
      };
    },
  },
};

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
YoPlanning	`app`	`app`	This component uses the YoPlanning app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling schedule	`timer`	`$.interface.timer`	How often to poll the API
Team ID	`teamId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Your API Key is sent to your email when you request it, see YoPlanning API Documentation for more information.

About YoPlanning#

Yoplanning automates your processes and helps you streamline your activity thanks to powerful decision-making algorithms based on artificial intelligence.

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