Create Commercial Listing with Domain Group API on New SNS Messages from AWS API

Pipedream makes it easy to connect APIs for Domain Group, AWS and 2,500+ other apps remarkably fast.

Trigger workflow on

New SNS Messages from the AWS API

Next, do this

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

Select this integration
Configure the New SNS Messages trigger
1. Connect your AWS account
2. Select a AWS Region
3. Optional- Select a SNS Topic
4. Optional- Configure SNS Topic Name
Configure the Create Commercial Listing action
1. Connect your Domain Group account
2. Select a Agency ID
3. Configure Provider Ad ID
4. Select a Property Type
5. Select a Listing Action
6. Optional- Configure Under Offer or Contract
7. Optional- Configure NABERS
8. Optional- Configure Description
9. Optional- Configure Features
10. Configure Street Number
11. Optional- Configure Unit Number
12. Configure Street
13. Select a State
14. Configure Suburb
15. Configure Postcode
16. Configure Area Value
17. Select a Area Unit
18. Optional- Configure Receive Emails to Default Address
19. Optional- Configure Is Rural?
20. Optional- Select a Occupancy Type
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 SNS Messages on AWS

Description:Creates an SNS topic in your AWS account. Messages published to this topic are emitted from the Pipedream source.

Version:0.4.2

Key:aws-new-sns-messages

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import base from "../common/sns.mjs";
import { toSingleLineString } from "../../common/utils.mjs";
import commonSNS from "../../common/common-sns.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  ...base,
  key: "aws-new-sns-messages",
  name: "New SNS Messages",
  description: toSingleLineString(`
    Creates an SNS topic in your AWS account.
    Messages published to this topic are emitted from the Pipedream source.
  `),
  version: "0.4.2",
  type: "source",
  dedupe: "unique", // Dedupe on SNS message ID
  props: {
    ...base.props,
    topicArn: {
      ...commonSNS.props.topic,
      optional: true,
    },
    topic: {
      label: "SNS Topic Name",
      description: toSingleLineString(`
        **Pipedream will create an SNS topic with this name in your account**,
        converting it to a [valid SNS topic
        name](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html).
      `),
      type: "string",
      optional: true,
    },
  },
  methods: {
    ...base.methods,
    getTopicName() {
      return this.convertNameToValidSNSTopicName(this.topic);
    },
  },
  async run(event) {
    if (!this.topicArn && !this.topic) {
      throw new ConfigurationError("Must specify either an existing topic or a new topic name");
    }

    if (this._isSubscriptionConfirmationEvent(event)) {
      const { body } = event;
      const subscriptionArn = await this._confirmSubscription(body);
      this._setSubscriptionArn(subscriptionArn);
      return;
    }

    await this.processEvent(event);
  },
};

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
AWS	`aws`	`app`	This component uses the AWS 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.
AWS Region	`region`	`string`	Select a value from the drop down menu.
SNS Topic	`topicArn`	`string`	Select a value from the drop down menu.
SNS Topic Name	`topic`	`string`	Pipedream will create an SNS topic with this name in your account, converting it to a valid SNS topic name

Trigger Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Action#

Create Commercial Listing on Domain Group

Description:Creates a new commercial listing. [See the documentation](https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/references/listings_upsertcommerciallisting/).

Version:0.0.1

Key:domain_group-create-commercial-listing

View on GitHub

Action Code#

import domainGroup from "../../domain_group.app.mjs";
import { COMMERCIAL_TYPES } from "../../common/property-types.mjs";

export default {
  key: "domain_group-create-commercial-listing",
  name: "Create Commercial Listing",
  description: "Creates a new commercial listing. [See the documentation](https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/references/listings_upsertcommerciallisting/).",
  version: "0.0.1",
  type: "action",
  props: {
    domainGroup,
    agencyId: {
      propDefinition: [
        domainGroup,
        "agencyId",
      ],
    },
    providerAdId: {
      propDefinition: [
        domainGroup,
        "providerAdId",
      ],
    },
    propertyType: {
      propDefinition: [
        domainGroup,
        "propertyType",
      ],
      options: COMMERCIAL_TYPES,
    },
    listingAction: {
      propDefinition: [
        domainGroup,
        "listingAction",
      ],
      reloadProps: true,
    },
    underOfferOrContract: {
      propDefinition: [
        domainGroup,
        "underOfferOrContract",
      ],
    },
    nabers: {
      propDefinition: [
        domainGroup,
        "nabers",
      ],
    },
    description: {
      propDefinition: [
        domainGroup,
        "description",
      ],
    },
    features: {
      propDefinition: [
        domainGroup,
        "features",
      ],
    },
    streetNumber: {
      propDefinition: [
        domainGroup,
        "streetNumber",
      ],
    },
    unitNumber: {
      propDefinition: [
        domainGroup,
        "unitNumber",
      ],
    },
    street: {
      propDefinition: [
        domainGroup,
        "street",
      ],
    },
    state: {
      propDefinition: [
        domainGroup,
        "state",
      ],
    },
    suburb: {
      propDefinition: [
        domainGroup,
        "suburb",
      ],
    },
    postcode: {
      propDefinition: [
        domainGroup,
        "postcode",
      ],
    },
    areaValue: {
      type: "string",
      label: "Area Value",
      description: "The size of the area in the commercial listing",
    },
    areaUnit: {
      type: "string",
      label: "Area Unit",
      description: "The unit of measure of the area value",
      options: [
        "squareMetres",
        "acres",
        "hectares",
        "squareFeet",
        "squareYards",
        "squares",
      ],
    },
    receiveEmailsToDefaultAddress: {
      propDefinition: [
        domainGroup,
        "receiveEmailsToDefaultAddress",
      ],
    },
    isRural: {
      propDefinition: [
        domainGroup,
        "isRural",
      ],
    },
    occupancyType: {
      type: "string",
      label: "Occupancy Type",
      description: "The occupancy type of the listing",
      options: [
        "tenanted",
        "vacant",
      ],
      optional: true,
    },
  },
  additionalProps() {
    const props = {};
    if (!this.listingAction) {
      return props;
    }

    const saleFromPrice = {
      type: "integer",
      label: "Sale - From Price",
      description: "Lowest price the property is expected to sell for to set search price. For a fixed price, set this value the same as To Price",
    };
    const saleToPrice = {
      type: "integer",
      label: "Sale - To Price",
      description: "Highest price the property is expected to sell for to set search price. For a fixed price, set this value the same as From Price",
    };
    const leaseFromPrice = {
      type: "integer",
      label: "Lease - From Price",
      description: "Lowest price the property is expected to rent for to set search price. For a fixed price, set this value the same as To Price",
    };
    const leaseToPrice = {
      type: "integer",
      label: "Lease - To Price",
      description: "Highest price the property is expected to rent for to set search price. For a fixed price, set this value the same as From Price",
    };

    if (this.listingAction === "sale") {
      props.saleFromPrice = saleFromPrice;
      props.saleToPrice = saleToPrice;
    }
    if (this.listingAction === "rent") {
      props.leaseFromPrice = leaseFromPrice;
      props.leaseToPrice = leaseToPrice;
    }
    if (this.listingAction === "saleAndLease") {
      props.saleFromPrice = saleFromPrice;
      props.saleToPrice = saleToPrice;
      props.leaseFromPrice = leaseFromPrice;
      props.leaseToPrice = leaseToPrice;
    }

    return props;
  },
  async run({ $ }) {
    const response = await this.domainGroup.createCommercialListing({
      $,
      data: {
        domainAgencyID: this.agencyId,
        providerAdId: this.providerAdId,
        nabers: this.nabers,
        listingAction: this.listingAction,
        underOfferOrContract: this.underOfferOrContract,
        salePrice: this.saleFromPrice
          ? {
            from: this.saleFromPrice,
            to: this.saleToPrice,
          }
          : undefined,
        leasePrice: this.leaseFromPrice
          ? {
            from: this.leaseFromPrice,
            to: this.leaseToPrice,
          }
          : undefined,
        description: this.description,
        features: this.features,
        propertyDetails: {
          propertyType: [
            this.propertyType,
          ],
          address: {
            streetNumber: this.streetNumber,
            unitNumber: this.unitNumber,
            street: this.street,
            state: this.state,
            suburb: this.suburb,
            postcode: this.postcode,
          },
          area: {
            value: +this.areaValue,
            unit: this.areaUnit,
          },
        },
        receiveEmailsToDefaultAddress: this.receiveEmailsToDefaultAddress,
        isRural: this.isRural,
        occupancyType: this.occupancyType,
      },
    });
    $.export("$summary", `Created commercial listing with ID: ${response.id}`);
    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
Domain Group	`domainGroup`	`app`	This component uses the Domain Group app.
Agency ID	`agencyId`	`string`	Select a value from the drop down menu.
Provider Ad ID	`providerAdId`	`string`	Must be unique. If Provider Ad ID supplied already exists, the listing will be updated. External Advertisement Id of up to 50 characters will be stored. This value is used to identify an Advertisement for updates and should be unique for listing provider. This value is case-insensitive (meaning AAAA will update aaaa).
Property Type	`propertyType`	`string`	Select a value from the drop down menu:`aquaculturedairyFarmingdevelopmentLandfishingForestryhotelLeisureindustrialWarehouseirrigationServiceslivestockinternationalCommercialmedicalConsultingofficesparkingCarSpaceretailruralCommercialFarmingshowroomsBulkyGoodsservicedOfficesothercroppingviticulturemixedFarminggrazinghorticultureequinefarmletorchardruralLifestyle`
Listing Action	`listingAction`	`string`	Select a value from the drop down menu:`salerentsaleAndLease`
Under Offer or Contract	`underOfferOrContract`	`boolean`	Set for Sale listings only
NABERS	`nabers`	`string`	The NABERS Rating is the energy efficiency rating that the property has been measured to have. This rating is measured in increments of .5 and can range from 0 to 6. The NABERS rating is required for spaces within office buildings of 1000 square metres or more. For more information on the NABERS rating system please visit http://www.nabers.gov.au
Description	`description`	`string`	Description of the property
Features	`features`	`string`	Comma-separated list of features
Street Number	`streetNumber`	`string`	Street number of the listing address
Unit Number	`unitNumber`	`string`	Unit number of the listing address
Street	`street`	`string`	Street of the listing address
State	`state`	`string`	Select a value from the drop down menu:`nswvicactsawatasqldnt`
Suburb	`suburb`	`string`	Suburb of the listing address
Postcode	`postcode`	`string`	Post code of the listing address
Area Value	`areaValue`	`string`	The size of the area in the commercial listing
Area Unit	`areaUnit`	`string`	Select a value from the drop down menu:`squareMetresacreshectaressquareFeetsquareYardssquares`
Receive Emails to Default Address	`receiveEmailsToDefaultAddress`	`boolean`	Send email enquiries to the default address for this listing type
Is Rural?	`isRural`	`boolean`	True if the property is rural
Occupancy Type	`occupancyType`	`string`	Select a value from the drop down menu:`tenantedvacant`

Action Authentication#

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

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

openidprofileoffline_accessapi_listings_readapi_listings_writeapi_agencies_readapi_agencies_write api_agencies_write

About Domain Group#

Domain.com.au | Real Estate & Properties For Sale & Rent

More Ways to Connect Domain Group + AWS#

Other Popular Integrations#

Create Business Listing with Domain Group API on New DynamoDB Stream Event from AWS API

AWS + Domain Group

Create Commercial Listing with Domain Group API on New SNS Messages from AWS API

Pipedream makes it easy to connect APIs for Domain Group, AWS and 2,500+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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