Add Keyword with Raven Tools API on New Branch (Instant) from BitBucket API

Pipedream makes it easy to connect APIs for Raven Tools, BitBucket and 2,800+ other apps remarkably fast.

Trigger workflow on

New Branch (Instant) from the BitBucket API

Next, do this

Add Keyword with the Raven Tools 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 BitBucket trigger and Raven Tools action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Branch (Instant) trigger
1. Connect your BitBucket account
2. Select a Workspace
3. Select a Repository
Configure the Add Keyword action
1. Connect your Raven Tools account
2. Select a Domain
3. Configure Keyword
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 Branch (Instant) on BitBucket

Description:Emit new event when a new branch is created. [See docs here](https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-hooks-post)

Version:0.0.4

Key:bitbucket-new-branch

View on GitHub

BitBucket Overview#

The BitBucket API taps the potential of BitBucket's Git-based version control system, enabling you to automate workflows around code commits, pull requests, and overall repository management. With this API, you can streamline the collaboration process, enforce coding standards, or integrate with other tools to create a cohesive development ecosystem. Pipedream, as a serverless integration and compute platform, provides a seamless environment to connect BitBucket with various apps and services, enabling you to harness its API for efficient, customized automations.

Trigger Code#

import common from "../common/common.mjs";
import constants from "../common/constants.mjs";
const { bitbucket } = common.props;

export default {
  ...common,
  type: "source",
  name: "New Branch (Instant)",
  key: "bitbucket-new-branch",
  description: "Emit new event when a new branch is created. [See docs here](https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-hooks-post)",
  version: "0.0.4",
  props: {
    ...common.props,
    repositoryId: {
      propDefinition: [
        bitbucket,
        "repository",
        (c) => ({
          workspaceId: c.workspaceId,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    getPath() {
      return `repositories/${this.workspaceId}/${this.repositoryId}/hooks`;
    },
    getWebhookEventTypes() {
      return [
        "repo:push",
      ];
    },
    isNewBranch(change) {
      return !change.new || change.old || change.new?.type !== "branch";
    },
    async loadHistoricalData() {
      const branches = await this.bitbucket.getBranches({
        workspaceId: this.workspaceId,
        repositoryId: this.repositoryId,
        params: {
          page: 1,
          pagelen: constants.HISTORICAL_DATA_LENGTH,
        },
      });
      const ts = new Date().getTime();
      return branches.map((branch) => ({
        main: branch,
        sub: {
          id: `${branch.name}-${ts}`,
          summary: `New branch ${branch.name} created`,
          ts,
        },
      }));
    },
    async proccessEvent(event) {
      const { push } = event.body;

      if (!push || !push.changes) return;

      push.changes.forEach((change) => {
        if (!this.isNewBranch(change)) return;

        const ts = new Date().getTime();

        this.$emit(change, {
          id: `${change.new.name}-${ts}`,
          summary: `New branch ${change.new.name} created`,
          ts,
        });
      });
    },
  },
};

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
BitBucket	`bitbucket`	`app`	This component uses the BitBucket app.
Workspace	`workspaceId`	`string`	Select a value from the drop down menu.
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.
Repository	`repositoryId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

accountaccount:writeteam:writerepository:writepullrequest:writesnippet:writeissue:writeemailwikiwebhook

About BitBucket#

Bitbucket Cloud is a Git-based code and CI/CD tool optimized for teams using Jira.

Action#

Add Keyword on Raven Tools

Description:Add a keyword to a domain [See docs here](https://api.raventools.com/docs/#add_keyword)

Version:0.0.1

Key:raven_tools-add-keyword

View on GitHub

Raven Tools Overview#

Raven Tools is a comprehensive suite of SEO tools that helps marketers to conduct audits, track search engine rankings, and analyze competitors' strategies. With the Raven Tools API, one can programmatically access this wealth of SEO data and generate reports, manage link building campaigns, and monitor keyword rankings. Leveraging the Pipedream platform, you can create automated workflows that react to various triggers and connect Raven Tools with other services to streamline SEO processes, enhance data analysis, and improve decision-making.

Action Code#

import app from "../../app/raven_tools.app.mjs";
import { defineAction } from "@pipedream/types";
const DOCS = "https://api.raventools.com/docs/#add_keyword";
export default defineAction({
    name: "Add Keyword",
    description: `Add a keyword to a domain [See docs here](${DOCS})`,
    key: "raven_tools-add-keyword",
    version: "0.0.1",
    type: "action",
    props: {
        app,
        domain: {
            propDefinition: [
                app,
                "domain",
            ],
            description: "The domain to add the keyword to.",
        },
        keyword: {
            label: "Keyword",
            description: "The keyword to add.",
            type: "string",
        },
    },
    async run({ $ }) {
        const { domain, keyword, } = this;
        const params = {
            $,
            params: {
                domain,
                keyword,
            },
        };
        const data = await this.app.addKeyword(params);
        if (data?.response !== "success") {
            throw new Error(`Something went wrong. RavenTools response: ${data && JSON.stringify(data)}`);
        }
        $.export("$summary", `Successfully added keyword "${keyword}"`);
        return 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
Raven Tools	`app`	`app`	This component uses the Raven Tools app.
Domain	`domain`	`string`	Select a value from the drop down menu.
Keyword	`keyword`	`string`	The keyword to add.

Action Authentication#

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

In order to use Raven's API, you must create an API key for each Profile that you want to use with the API. This key is generated through the following steps:

Navigate to Preferences > Profile Manager.
Click the name of the Profile that you would like to generate an API key for.
On this page, click the Get New API Key button.

Add Keyword with Raven Tools API on New Branch (Instant) from BitBucket API

Pipedream makes it easy to connect APIs for Raven Tools, BitBucket and 2,800+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

1
-
24
of
2,800+
apps by most popular