Create Commercial Listing with Domain Group API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform 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 Typeform 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 Submission trigger
1. Connect your Typeform account
2. Select a Form
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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  sampleEmit,
};

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
Typeform	`typeform`	`app`	This component uses the Typeform 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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

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