Add Blocked Off Time with Acuity Scheduling API on New Customer Created (Instant) from Shopify API

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

Trigger workflow on

New Customer Created (Instant) from the Shopify API

Next, do this

Add Blocked Off Time 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 Shopify 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 Customer Created (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Add Blocked Off Time action
1. Connect your Acuity Scheduling account
2. Configure Start Time
3. Configure End Time
4. Select a Calendar ID
5. Optional- Configure Notes
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 Customer Created (Instant) on Shopify

Description:Emit new event for each new customer added to a store.

Version:0.0.4

Key:shopify_developer_app-new-customer-created

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Trigger Code#

import constants from "../common/constants.mjs";
import common from "../common/webhook-metafields.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-customer-created",
  name: "New Customer Created (Instant)",
  type: "source",
  description: "Emit new event for each new customer added to a store.",
  version: "0.0.4",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.CUSTOMERS_CREATE;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.created_at);
      return {
        id: resource.id,
        summary: `New Customer ${resource.id}.`,
        ts,
      };
    },
  },
};

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
Shopify	`app`	`app`	This component uses the Shopify 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.
Metafield Namespaces	`metafieldNamespaces`	`string[]`	Array of namespaces for any metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.

Trigger Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

Action#

Add Blocked Off Time on Acuity Scheduling

Description:Blocks a specific time slot on your schedule to prevent the scheduling of any appointments during this particular time range. [See the documentation](https://developers.acuityscheduling.com/reference/post-blocks)

Version:0.0.1

Key:acuity_scheduling-add-blocked-off-time

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";

export default {
  key: "acuity_scheduling-add-blocked-off-time",
  name: "Add Blocked Off Time",
  description: "Blocks a specific time slot on your schedule to prevent the scheduling of any appointments during this particular time range. [See the documentation](https://developers.acuityscheduling.com/reference/post-blocks)",
  version: "0.0.1",
  type: "action",
  props: {
    acuityScheduling,
    startTime: {
      propDefinition: [
        acuityScheduling,
        "startTime",
      ],
    },
    endTime: {
      propDefinition: [
        acuityScheduling,
        "endTime",
      ],
    },
    calendarId: {
      propDefinition: [
        acuityScheduling,
        "calendarId",
      ],
    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Any notes to include for the blocked off time",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.acuityScheduling.blockTime({
      $,
      data: {
        start: this.startTime,
        end: this.endTime,
        calendarID: this.calendarId,
        notes: this.notes,
      },
    });

    $.export("$summary", `Successfully blocked off time from ${this.startTime} to ${this.endTime}`);
    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
Acuity Scheduling	`acuityScheduling`	`app`	This component uses the Acuity Scheduling app.
Start Time	`startTime`	`string`	The starting time to block off (e.g., '2023-01-01T00:00:00Z').
End Time	`endTime`	`string`	The ending time of the blocked off period (e.g., '2023-01-01T01:00:00Z').
Calendar ID	`calendarId`	`string`	Select a value from the drop down menu.
Notes	`notes`	`string`	Any notes to include for the blocked off time

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 + Shopify#

Other Popular Integrations#

Add Products to Custom Collections with Shopify Developer App API on New Appointment (Instant) from Acuity Scheduling API

Acuity Scheduling + Shopify

Add Blocked Off Time with Acuity Scheduling API on New Customer Created (Instant) from Shopify API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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