Find Appointments by Client Info with Acuity Scheduling API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for Acuity Scheduling, Typeform and 2,900+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

Find Appointments by Client Info with the Acuity Scheduling 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 Acuity Scheduling 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 Find Appointments by Client Info action
1. Connect your Acuity Scheduling account
2. Optional- Select a Calendar ID
3. Optional- Select a Appointment Type ID
4. Optional- Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Email
7. Optional- Configure Phone
8. Optional- Configure Custom Field
9. Optional- Configure Show All
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#

Find Appointments by Client Info on Acuity Scheduling

Description:Retrieves existing appointments using the client's information, allowing you to track all the appointments associated with a specific client. [See the documentation](https://developers.acuityscheduling.com/reference/get-appointments)

Version:0.0.3

Key:acuity_scheduling-find-appointments-by-client-info

View on GitHub

Acuity Scheduling Overview#

Acuity Scheduling API allows you to tap into the functionality of Acuity Scheduling, a cloud-based appointment scheduling software. With this API on Pipedream, you can automate appointment creation, modifications, and cancellations, as well as sync customer data across your tech stack. The API lets you fetch detailed information about schedules, available time slots, and calendar events. Create dynamic, real-time integrations with CRMs, email marketing platforms, or payment gateways to streamline your scheduling and business processes.

Action Code#

import acuityScheduling from "../../acuity_scheduling.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "acuity_scheduling-find-appointments-by-client-info",
  name: "Find Appointments by Client Info",
  description: "Retrieves existing appointments using the client's information, allowing you to track all the appointments associated with a specific client. [See the documentation](https://developers.acuityscheduling.com/reference/get-appointments)",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    acuityScheduling,
    calendarID: {
      propDefinition: [
        acuityScheduling,
        "calendarId",
      ],
      optional: true,
    },
    appointmentTypeID: {
      propDefinition: [
        acuityScheduling,
        "appointmentTypeId",
      ],
      optional: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "Filter appointments for client first name.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Filter appointments for client last name.",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "Filter appointments for client email address.",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Filter appointments for client phone.",
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Field",
      description: "Filter appointments matching a particular custom intake form field **eg. ?field:1234=Hello**",
      optional: true,
    },
    showAll: {
      type: "boolean",
      label: "Show All",
      description: "To retrieve both canceled and scheduled appointments.",
      optional: true,
    },
  },
  async run({ $ }) {
    let params = {
      calendarID: this.calendarID,
      appointmentTypeID: this.appointmentTypeID,
      firstName: this.firstName,
      lastName: this.lastName,
      email: this.email,
      phone: this.phone,
      showAll: this.showAll,
    };

    if (this.customFields) {
      params = {
        ...params,
        ...parseObject(this.customFields),
      };
    }
    const appointments = await this.acuityScheduling.listAppointments({
      $,
      params,
    });

    $.export("$summary", `Found ${appointments.length} appointments for the search!`);
    return appointments;
  },
};

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
Acuity Scheduling	`acuityScheduling`	`app`	This component uses the Acuity Scheduling app.
Calendar ID	`calendarID`	`string`	Select a value from the drop down menu.
Appointment Type ID	`appointmentTypeID`	`string`	Select a value from the drop down menu.
First Name	`firstName`	`string`	Filter appointments for client first name.
Last Name	`lastName`	`string`	Filter appointments for client last name.
Email	`email`	`string`	Filter appointments for client email address.
Phone	`phone`	`string`	Filter appointments for client phone.
Custom Field	`customFields`	`object`	Filter appointments matching a particular custom intake form field eg. ?field:1234=Hello
Show All	`showAll`	`boolean`	To retrieve both canceled and scheduled appointments.

Action Authentication#

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

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

api-v1