Find Appointments by Client Info with Acuity Scheduling API on New Scheduled Tasks from AWS API

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

Trigger workflow on

New Scheduled Tasks from the AWS 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 AWS 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 Scheduled Tasks trigger
1. Connect your AWS account
2. Select a AWS Region
3. Optional- Configure Secret
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 Scheduled Tasks on AWS

Description:Creates a Step Function State Machine to publish a message to an SNS topic at a specific timestamp. The SNS topic delivers the message to this Pipedream source, and the source emits it as a new event.

Version:0.4.2

Key:aws-new-scheduled-tasks

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/scheduled.mjs";
import { toSingleLineString } from "../../common/utils.mjs";

export default {
  ...base,
  key: "aws-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  description: toSingleLineString(`
    Creates a Step Function State Machine to publish a message
    to an SNS topic at a specific timestamp. The SNS topic delivers
    the message to this Pipedream source, and the source emits it as a new event.
  `),
  version: "0.4.2",
  type: "source",
  dedupe: "unique", // Dedupe on SNS message ID
  methods: {
    ...base.methods,
    getStateMachineDefinition() {
      const { PD_COMPONENT: componentId } = process.env;
      const topicArn = this.getTopicArn();
      return {
        Comment: `Task Scheduler for Pipedream component ${componentId}`,
        StartAt: "Wait",
        States: {
          Wait: {
            Comment: "Wait until specified timestamp",
            Type: "Wait",
            TimestampPath: "$.timestamp",
            Next: "SendMessageToSNS",
          },
          SendMessageToSNS: {
            Type: "Task",
            Resource: "arn:aws:states:::sns:publish",
            Parameters: {
              "TopicArn": topicArn,
              "Message.$": "$",
            },
            End: true,
          },
        },
      };
    },
    getStateMachinePermissions() {
      const topicArn = this.getTopicArn();
      const document = {
        Version: "2012-10-17",
        Statement: [
          {
            Effect: "Allow",
            Action: [
              "sns:Publish",
            ],
            Resource: [
              topicArn,
            ],
          },
        ],
      };
      const name = "publish-messages-to-pipedream-sns-topic";
      return {
        document,
        name,
      };
    },
  },
};

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.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `secret` parameter of each HTTP POST request

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#

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.1

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.1",
  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

About Acuity Scheduling#

Online Appointment Scheduling

More Ways to Connect Acuity Scheduling + AWS#

Other Popular Integrations#

Add Blocked Off Time with Acuity Scheduling API on New DynamoDB Stream Event from AWS API

AWS + Acuity Scheduling

Find Appointments by Client Info with Acuity Scheduling API on New Scheduled Tasks from AWS API

Pipedream makes it easy to connect APIs for Acuity Scheduling, AWS 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