Create Branch with GitHub API on New Property Created (Instant) from Melo API

Pipedream makes it easy to connect APIs for GitHub, Melo and 2,400+ other apps remarkably fast.

Trigger workflow on

New Property Created (Instant) from the Melo API

Next, do this

Create Branch with the GitHub 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 Melo trigger and GitHub action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Property Created (Instant) trigger
1. Connect your Melo account
2. Configure Title
3. Select a Transaction Type
4. Select one or more Property Types
5. Optional- Configure Minimum Bedrooms
6. Optional- Configure Maximum Bedrooms
7. Optional- Configure Minimum Budget
8. Configure Maximum Budget
9. Optional- Configure Excluded Cities
10. Optional- Configure Excluded Site Categories
11. Optional- Configure Furnished
12. Optional- Configure Hide Property Contact
13. Optional- Configure Included Cities
14. Optional- Configure Included Departments
15. Optional- Configure Included Site Categories
16. Optional- Configure Included Zipcodes
17. Optional- Configure Maximum Land Surface
18. Optional- Configure Minimum Land Surface
19. Optional- Configure Latitude
20. Optional- Configure Longitude
21. Optional- Configure Maximum Price Per Meter
22. Optional- Configure Minimum Price Per Meter
23. Optional- Select one or more Publisher Types
24. Optional- Configure Radius
25. Optional- Configure Minimum Number of Rooms
26. Optional- Configure Maximum Number of Rooms
27. Optional- Configure Maximum Surface Area
28. Optional- Configure Minimum Surface Area
29. Optional- Configure With Coherent Price
30. Optional- Configure With Virtual Tour
Configure the Create Branch action
1. Connect your GitHub account
2. Select a Repository
3. Configure Branch Name
4. Optional- Select a Source Branch
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 Property Created (Instant) on Melo

Description:Emit new event when a new property ad is created in Melo. Requires a Production Environment.

Version:0.0.1

Key:melo-new-property-created

View on GitHub

Melo Overview#

Melo API enables you to manage and automate tasks related to project management and team collaboration. Utilize Melo's endpoints to create tasks, update project details, manage team assignments, and retrieve project metrics. Integrating Melo API with Pipedream allows you to connect your project management workflows with other apps and services, streamlining productivity and providing real-time updates across your tech stack.

Trigger Code#

import melo from "../../melo.app.mjs";
import constants from "../../common/constants.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "melo-new-property-created",
  name: "New Property Created (Instant)",
  description: "Emit new event when a new property ad is created in Melo. Requires a Production Environment.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    melo,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    title: {
      type: "string",
      label: "Title",
      description: "Title of the created search.",
    },
    transactionType: {
      type: "string",
      label: "Transaction Type",
      description: "Type of transaction. Sell 0, Rent 1.",
      options: constants.TRANSACTION_TYPES,
    },
    propertyTypes: {
      type: "string[]",
      label: "Property Types",
      description: "Type of property. Apartment 0, House 1, Building 2, Parking 3, Office 4, Land 5, Shop 6. Example: propertyTypes[]=0&propertyTypes[]=1",
      options: constants.PROPERTY_TYPES,
    },
    bedroomMin: {
      type: "integer",
      label: "Minimum Bedrooms",
      description: "Minimum number of bedrooms in the property.",
      optional: true,
    },
    bedroomMax: {
      type: "integer",
      label: "Maximum Bedrooms",
      description: "Maximum number of bedrooms in the property.",
      optional: true,
    },
    budgetMin: {
      type: "integer",
      label: "Minimum Budget",
      description: "Minimum budget for the property.",
      optional: true,
    },
    budgetMax: {
      type: "integer",
      label: "Maximum Budget",
      description: "Maximum budget for the property.",
    },
    excludedCities: {
      type: "string[]",
      label: "Excluded Cities",
      description: "Cities to be excluded.",
      optional: true,
    },
    excludedSiteCategories: {
      type: "string[]",
      label: "Excluded Site Categories",
      description: "Site categories to be excluded.",
      optional: true,
    },
    furnished: {
      type: "boolean",
      label: "Furnished",
      description: "Whether the property is furnished or not.",
      optional: true,
    },
    hidePropertyContact: {
      type: "boolean",
      label: "Hide Property Contact",
      description: "Whether to hide property contact information or not.",
      optional: true,
    },
    includedCities: {
      type: "string[]",
      label: "Included Cities",
      description: "Included cities.",
      optional: true,
    },
    includedDepartments: {
      type: "string[]",
      label: "Included Departments",
      description: "Included departments.",
      optional: true,
    },
    includedSiteCategories: {
      type: "string[]",
      label: "Included Site Categories",
      description: "Included site categories.",
      optional: true,
    },
    includedZipcodes: {
      type: "string[]",
      label: "Included Zipcodes",
      description: "Included zipcodes.",
      optional: true,
    },
    landSurfaceMax: {
      type: "integer",
      label: "Maximum Land Surface",
      description: "Maximum land surface.",
      optional: true,
    },
    landSurfaceMin: {
      type: "integer",
      label: "Minimum Land Surface",
      description: "Minimum land surface.",
      optional: true,
    },
    lat: {
      type: "string",
      label: "Latitude",
      description: "Latitude. Will work if latitude exists in the property.",
      optional: true,
    },
    lon: {
      type: "string",
      label: "Longitude",
      description: "Longitude. Will work if latitude exists in the property.",
      optional: true,
    },
    pricePerMeterMax: {
      type: "integer",
      label: "Maximum Price Per Meter",
      description: "Maximum price per meter.",
      optional: true,
    },
    pricePerMeterMin: {
      type: "integer",
      label: "Minimum Price Per Meter",
      description: "Minimum price per meter.",
      optional: true,
    },
    publisherTypes: {
      type: "string[]",
      label: "Publisher Types",
      description: "Type of publisher. Individual 0, Professional 1.",
      options: constants.PUBLISHER_TYPES,
      optional: true,
    },
    radius: {
      type: "integer",
      label: "Radius",
      description: "Distance expressed in kilometers. Will work if latitude & longitude parameters are also set.",
      optional: true,
    },
    roomMin: {
      type: "integer",
      label: "Minimum Number of Rooms",
      description: "Minimum number of rooms.",
      optional: true,
    },
    roomMax: {
      type: "integer",
      label: "Maximum Number of Rooms",
      description: "Maximum number of rooms.",
      optional: true,
    },
    surfaceMax: {
      type: "integer",
      label: "Maximum Surface Area",
      description: "Maximum property surface area.",
      optional: true,
    },
    surfaceMin: {
      type: "integer",
      label: "Minimum Surface Area",
      description: "Minimum property surface area.",
      optional: true,
    },
    withCoherentPrice: {
      type: "boolean",
      label: "With Coherent Price",
      description: "Having properties with coherent prices.",
      optional: true,
      default: true,
    },
    withVirtualTour: {
      type: "boolean",
      label: "With Virtual Tour",
      description: "Whether the property includes a virtual tour.",
      optional: true,
    },
  },
  hooks: {
    async deploy() {
      if (!this.includedCities?.length
        && !this.includedDepartments?.length
        && !(this.lat && this.lon && this.radius)
      ) {
        throw new ConfigurationError("Choose at least one location. IncludedCities or includedDepartments or radius/lon/lat.");
      }

      const {
        melo,
        http,
        transactionType,
        propertyTypes,
        publisherTypes,
        lat,
        lon,
        ...data
      } = this;

      try {
        await melo.createSearch({
          data: {
            subscribedEvents: [
              "property.ad.create",
            ],
            notificationEnabled: true,
            endpointRecipient: http.endpoint,
            transactionType: parseInt(transactionType),
            propertyTypes: propertyTypes.map((type) => parseInt(type)),
            publisherTypes: publisherTypes?.length
              ? publisherTypes.map((type) => parseInt(type))
              : undefined,
            lat: lat
              ? parseFloat(lat)
              : undefined,
            lon: lon
              ? parseFloat(lon)
              : undefined,
            ...data,
          },
        });
      } catch (e) {
        const message = JSON.parse(e.message);
        if (message["hydra:description"] === "Access Denied.") {
          throw new ConfigurationError(`${message["hydra:description"]} Creating webhooks requires a Production Environment API Key.`);
        }
        throw new Error(JSON.stringify(message));
      }
    },
  },
  async run(event) {
    this.http.respond({
      status: 200,
    });

    const { body } = event;
    this.$emit(body, {
      id: body.match["@id"],
      summary: `${body.match.propertyDocument.title}`,
      ts: Date.parse(body.match.createdAt),
    });
  },
};

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
Melo	`melo`	`app`	This component uses the Melo app.
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.
Title	`title`	`string`	Title of the created search.
Transaction Type	`transactionType`	`string`	Select a value from the drop down menu:`{ "value": "0", "label": "Sell" }{ "value": "1", "label": "Rent" }`
Property Types	`propertyTypes`	`string[]`	Select a value from the drop down menu:`{ "value": "0", "label": "Apartment" }{ "value": "1", "label": "House" }{ "value": "2", "label": "Building" }{ "value": "3", "label": "Parking" }{ "value": "4", "label": "Office" }{ "value": "5", "label": "Land" }{ "value": "6", "label": "Shop" }`
Minimum Bedrooms	`bedroomMin`	`integer`	Minimum number of bedrooms in the property.
Maximum Bedrooms	`bedroomMax`	`integer`	Maximum number of bedrooms in the property.
Minimum Budget	`budgetMin`	`integer`	Minimum budget for the property.
Maximum Budget	`budgetMax`	`integer`	Maximum budget for the property.
Excluded Cities	`excludedCities`	`string[]`	Cities to be excluded.
Excluded Site Categories	`excludedSiteCategories`	`string[]`	Site categories to be excluded.
Furnished	`furnished`	`boolean`	Whether the property is furnished or not.
Hide Property Contact	`hidePropertyContact`	`boolean`	Whether to hide property contact information or not.
Included Cities	`includedCities`	`string[]`	Included cities.
Included Departments	`includedDepartments`	`string[]`	Included departments.
Included Site Categories	`includedSiteCategories`	`string[]`	Included site categories.
Included Zipcodes	`includedZipcodes`	`string[]`	Included zipcodes.
Maximum Land Surface	`landSurfaceMax`	`integer`	Maximum land surface.
Minimum Land Surface	`landSurfaceMin`	`integer`	Minimum land surface.
Latitude	`lat`	`string`	Latitude. Will work if latitude exists in the property.
Longitude	`lon`	`string`	Longitude. Will work if latitude exists in the property.
Maximum Price Per Meter	`pricePerMeterMax`	`integer`	Maximum price per meter.
Minimum Price Per Meter	`pricePerMeterMin`	`integer`	Minimum price per meter.
Publisher Types	`publisherTypes`	`string[]`	Select a value from the drop down menu:`{ "value": "0", "label": "Individual" }{ "value": "1", "label": "Professional" }`
Radius	`radius`	`integer`	Distance expressed in kilometers. Will work if latitude & longitude parameters are also set.
Minimum Number of Rooms	`roomMin`	`integer`	Minimum number of rooms.
Maximum Number of Rooms	`roomMax`	`integer`	Maximum number of rooms.
Maximum Surface Area	`surfaceMax`	`integer`	Maximum property surface area.
Minimum Surface Area	`surfaceMin`	`integer`	Minimum property surface area.
With Coherent Price	`withCoherentPrice`	`boolean`	Having properties with coherent prices.
With Virtual Tour	`withVirtualTour`	`boolean`	Whether the property includes a virtual tour.

Trigger Authentication#

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

About Melo#

Power your business with comprehensive property data delivered via the most reactive real estate API

Action#

Create Branch on GitHub

Description:Create a new branch in a Github repo. [See the documentation](https://docs.github.com/en/rest/git/refs?apiVersion=2022-11-28#create-a-reference)

Version:0.0.13

Key:github-create-branch

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import github from "../../github.app.mjs";

export default {
  key: "github-create-branch",
  name: "Create Branch",
  description: "Create a new branch in a Github repo. [See the documentation](https://docs.github.com/en/rest/git/refs?apiVersion=2022-11-28#create-a-reference)",
  version: "0.0.13",
  type: "action",
  props: {
    github,
    repoFullname: {
      propDefinition: [
        github,
        "repoFullname",
      ],
    },
    branchName: {
      label: "Branch Name",
      description: "The name of the new branch that will be created",
      type: "string",
    },
    branchSha: {
      label: "Source Branch",
      description: "The source branch that will be used to create the new branch. Defaults to the repository's default branch (usually `main` or `master`)",
      propDefinition: [
        github,
        "branch",
        (c) => ({
          repoFullname: c.repoFullname,
        }),
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    if (this.branchSha) {
      this.branchSha = this.branchSha.split("/")[0];
    } else {
      const branches = await this.github.getBranches({
        repoFullname: this.repoFullname,
      });

      const masterBranch = branches.filter((branch) => branch.name === "master" || branch.name === "main");

      if (masterBranch.length) this.branchSha = masterBranch[0].commit.sha;
    }

    if (!this.branchSha) {
      throw new ConfigurationError("Is required to select one source branch");
    }

    const response = await this.github.createBranch({
      repoFullname: this.repoFullname,
      data: {
        ref: `refs/heads/${this.branchName}`,
        sha: this.branchSha,
      },
    });

    $.export("$summary", `Successfully created branch with ID ${response.object.sha}.`);

    return response;
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
Branch Name	`branchName`	`string`	The name of the new branch that will be created
Source Branch	`branchSha`	`string`	Select a value from the drop down menu.

Action Authentication#

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

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

repoadmin:orgadmin:public_keyadmin:org_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

Create Branch with GitHub API on New Property Created (Instant) from Melo API

Pipedream makes it easy to connect APIs for GitHub, Melo and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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