Create Incident with TOPdesk API on New Appointment (Instant) from Acuity Scheduling API

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

Trigger workflow on

New Appointment (Instant) from the Acuity Scheduling API

Next, do this

Create Incident with the TOPdesk 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 Acuity Scheduling trigger and TOPdesk action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Appointment (Instant) trigger
1. Connect your Acuity Scheduling account
Configure the Create Incident action
1. Connect your TOPdesk account
2. Select a Caller Lookup ID
3. Optional- Select a Status
4. Optional- Configure Brief Description
5. Optional- Configure Request
6. Optional- Configure Action
7. Optional- Configure Action Invisible For Caller
8. Optional- Select a Category ID
9. Optional- Select a Subcategory ID
10. Optional- Select a Call Type ID
11. Optional- Select a Entry Type ID
12. Optional- Configure External Number
13. Optional- Select a Object Name
14. Optional- Select a Location ID
15. Optional- Select a Branch ID
16. Optional- Configure Main Incident ID
17. Optional- Select a Impact ID
18. Optional- Select a Urgency ID
19. Optional- Select a Priority ID
20. Optional- Select a Duration ID
21. Optional- Configure Target Date
22. Optional- Select a SLA ID
23. Optional- Configure On Hold
24. Optional- Select a Operator
25. Optional- Select a Operator Group ID
26. Optional- Select a Supplier ID
27. Optional- Select a Processing Status ID
28. Optional- Configure Responded
29. Optional- Configure Response Date
30. Optional- Configure Completed
31. Optional- Configure Completed Date
32. Optional- Configure Closed
33. Optional- Configure Closed Date
34. Optional- Select a Closure Code ID
35. Optional- Configure Major Call
36. Optional- Configure Publish To SSD
37. Optional- Configure Optional Fields 1
38. Optional- Configure Optional Fields 2
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 Appointment (Instant) on Acuity Scheduling

Description:Emit new event when an appointment is scheduled.

Version:0.0.3

Key:acuity_scheduling-new-appointment-instant

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.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "acuity_scheduling-new-appointment-instant",
  name: "New Appointment (Instant)",
  description: "Emit new event when an appointment is scheduled.",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEvent() {
      return "appointment.scheduled";
    },
    getSummary(details) {
      return `New appointment scheduled with Id: ${details.id}`;
    },
  },
  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
Acuity Scheduling	`acuityScheduling`	`app`	This component uses the Acuity Scheduling 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.

Trigger 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

Action#

Create Incident on TOPdesk

Description:Creates a new incident. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/createIncident)

Version:0.0.1

Key:topdesk-create-incident

View on GitHub

Action Code#

import app from "../../topdesk.app.mjs";

export default {
  key: "topdesk-create-incident",
  name: "Create Incident",
  description: "Creates a new incident. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/createIncident)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    callerLookupId: {
      type: "string",
      label: "Caller Lookup ID",
      description: "Lookup value for filling in a registered caller's contact details (UUID). **Required** - you must specify either this field or provide caller details manually.",
      propDefinition: [
        app,
        "personId",
      ],
    },
    status: {
      type: "string",
      label: "Status",
      description: "Status of the incident. Can only be set by operators.",
      optional: true,
      options: [
        "firstLine",
        "secondLine",
        "partial",
      ],
    },
    briefDescription: {
      propDefinition: [
        app,
        "briefDescription",
      ],
    },
    request: {
      propDefinition: [
        app,
        "request",
      ],
    },
    action: {
      propDefinition: [
        app,
        "action",
      ],
    },
    actionInvisibleForCaller: {
      propDefinition: [
        app,
        "actionInvisibleForCaller",
      ],
    },
    categoryId: {
      propDefinition: [
        app,
        "categoryId",
      ],
    },
    subcategoryId: {
      propDefinition: [
        app,
        "subcategoryId",
        ({ categoryId }) => ({
          categoryId,
        }),
      ],
    },
    callTypeId: {
      propDefinition: [
        app,
        "callTypeId",
      ],
    },
    entryTypeId: {
      propDefinition: [
        app,
        "entryTypeId",
      ],
    },
    externalNumber: {
      propDefinition: [
        app,
        "externalNumber",
      ],
    },
    objectName: {
      propDefinition: [
        app,
        "objectName",
      ],
    },
    locationId: {
      propDefinition: [
        app,
        "locationId",
      ],
    },
    branchId: {
      propDefinition: [
        app,
        "branchId",
      ],
    },
    mainIncidentId: {
      type: "string",
      label: "Main Incident ID",
      description: "Main incident UUID, required for creating a partial incident. Can only be set by operators.",
      optional: true,
    },
    impact: {
      propDefinition: [
        app,
        "impactId",
      ],
    },
    urgency: {
      propDefinition: [
        app,
        "urgencyId",
      ],
    },
    priority: {
      propDefinition: [
        app,
        "priorityId",
      ],
    },
    duration: {
      propDefinition: [
        app,
        "durationId",
      ],
    },
    targetDate: {
      propDefinition: [
        app,
        "targetDate",
      ],
    },
    slaId: {
      propDefinition: [
        app,
        "slaId",
      ],
    },
    onHold: {
      propDefinition: [
        app,
        "onHold",
      ],
    },
    operatorId: {
      propDefinition: [
        app,
        "operatorId",
      ],
      label: "Operator",
      description: "The operator assigned to the incident. Can only be set by operators.",
      optional: true,
    },
    operatorGroupId: {
      propDefinition: [
        app,
        "operatorGroupId",
      ],
    },
    supplierId: {
      propDefinition: [
        app,
        "supplierId",
      ],
    },
    processingStatusId: {
      propDefinition: [
        app,
        "processingStatusId",
      ],
    },
    responded: {
      propDefinition: [
        app,
        "responded",
      ],
    },
    responseDate: {
      propDefinition: [
        app,
        "responseDate",
      ],
    },
    completed: {
      propDefinition: [
        app,
        "completed",
      ],
    },
    completedDate: {
      propDefinition: [
        app,
        "completedDate",
      ],
    },
    closed: {
      propDefinition: [
        app,
        "closed",
      ],
    },
    closedDate: {
      propDefinition: [
        app,
        "closedDate",
      ],
    },
    closureCodeId: {
      propDefinition: [
        app,
        "closureCodeId",
      ],
    },
    majorCall: {
      propDefinition: [
        app,
        "majorCall",
      ],
    },
    publishToSsd: {
      propDefinition: [
        app,
        "publishToSsd",
      ],
    },
    optionalFields1: {
      propDefinition: [
        app,
        "optionalFields1",
      ],
    },
    optionalFields2: {
      propDefinition: [
        app,
        "optionalFields2",
      ],
    },
  },
  annotations: {
    readOnlyHint: false,
    destructiveHint: false,
    openWorldHint: true,
    idempotentHint: false,
  },
  async run({ $ }) {
    const {
      app,
      callerLookupId,
      status,
      briefDescription,
      request,
      action,
      actionInvisibleForCaller,
      categoryId,
      subcategoryId,
      callTypeId,
      entryTypeId,
      externalNumber,
      objectName,
      locationId,
      branchId,
      mainIncidentId,
      impact,
      urgency,
      priority,
      duration,
      targetDate,
      slaId,
      onHold,
      operatorId,
      operatorGroupId,
      supplierId,
      processingStatusId,
      responded,
      responseDate,
      completed,
      completedDate,
      closed,
      closedDate,
      closureCodeId,
      majorCall,
      publishToSsd,
      optionalFields1,
      optionalFields2,
    } = this;

    // Fields that take { id: value } structure
    const idFields = [
      {
        value: callerLookupId,
        key: "callerLookup",
      },
      {
        value: categoryId,
        key: "category",
      },
      {
        value: subcategoryId,
        key: "subcategory",
      },
      {
        value: callTypeId,
        key: "callType",
      },
      {
        value: entryTypeId,
        key: "entryType",
      },
      {
        value: locationId,
        key: "location",
      },
      {
        value: branchId,
        key: "branch",
      },
      {
        value: mainIncidentId,
        key: "mainIncident",
      },
      {
        value: impact,
        key: "impact",
      },
      {
        value: urgency,
        key: "urgency",
      },
      {
        value: priority,
        key: "priority",
      },
      {
        value: duration,
        key: "duration",
      },
      {
        value: slaId,
        key: "sla",
      },
      {
        value: operatorId,
        key: "operator",
      },
      {
        value: operatorGroupId,
        key: "operatorGroup",
      },
      {
        value: supplierId,
        key: "supplier",
      },
      {
        value: processingStatusId,
        key: "processingStatus",
      },
      {
        value: closureCodeId,
        key: "closureCode",
      },
    ];

    const response = await app.createIncident({
      $,
      data: {
        status,
        briefDescription,
        request,
        action,
        actionInvisibleForCaller,
        externalNumber,
        targetDate,
        onHold,
        responded,
        responseDate,
        completed,
        completedDate,
        closed,
        closedDate,
        majorCall,
        publishToSsd,
        optionalFields1,
        optionalFields2,
        ...(objectName && {
          object: {
            name: objectName,
          },
        }),
        ...idFields.reduce((acc, {
          value, key,
        }) => ({
          ...acc,
          ...value && {
            [key]: {
              id: value,
            },
          },
        }), {}),
      },
    });

    $.export("$summary", `Successfully created incident 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
TOPdesk	`app`	`app`	This component uses the TOPdesk app.
Caller Lookup ID	`callerLookupId`	`string`	Select a value from the drop down menu.
Status	`status`	`string`	Select a value from the drop down menu:`firstLinesecondLinepartial`
Brief Description	`briefDescription`	`string`	Brief description of the incident (max 80 characters)
Request	`request`	`string`	The initial request text. HTML tags are supported: `<i>`, `<em>`, `<b>`, `<strong>`, `<u>`, `<br>`, `<h5>`, `<h6>`
Action	`action`	`string`	The action text to add. HTML tags are supported: `<i>`, `<em>`, `<b>`, `<strong>`, `<u>`, `<br>`, `<h5>`, `<h6>`
Action Invisible For Caller	`actionInvisibleForCaller`	`boolean`	Whether the action is invisible for persons. Can only be set by operators.
Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Subcategory ID	`subcategoryId`	`string`	Select a value from the drop down menu.
Call Type ID	`callTypeId`	`string`	Select a value from the drop down menu.
Entry Type ID	`entryTypeId`	`string`	Select a value from the drop down menu.
External Number	`externalNumber`	`string`	External number (max 60 characters). Can only be set by operators.
Object Name	`objectName`	`string`	Select a value from the drop down menu.
Location ID	`locationId`	`string`	Select a value from the drop down menu.
Branch ID	`branchId`	`string`	Select a value from the drop down menu.
Main Incident ID	`mainIncidentId`	`string`	Main incident UUID, required for creating a partial incident. Can only be set by operators.
Impact ID	`impact`	`string`	Select a value from the drop down menu.
Urgency ID	`urgency`	`string`	Select a value from the drop down menu.
Priority ID	`priority`	`string`	Select a value from the drop down menu.
Duration ID	`duration`	`string`	Select a value from the drop down menu.
Target Date	`targetDate`	`string`	Target date in ISO 8601 format (e.g., `2024-08-01T12:00:00.000+0200`). Can only be set by operators.
SLA ID	`slaId`	`string`	Select a value from the drop down menu.
On Hold	`onHold`	`boolean`	Whether the incident is on hold. Can only be set by operators.
Operator	`operatorId`	`string`	Select a value from the drop down menu.
Operator Group ID	`operatorGroupId`	`string`	Select a value from the drop down menu.
Supplier ID	`supplierId`	`string`	Select a value from the drop down menu.
Processing Status ID	`processingStatusId`	`string`	Select a value from the drop down menu.
Responded	`responded`	`boolean`	Whether the incident is responded. SLM-licence is needed. Can only be set by operators.
Response Date	`responseDate`	`string`	Response date in ISO 8601 format. SLM-licence is needed. Can only be set by operators.
Completed	`completed`	`boolean`	Whether the incident is completed. Can only be set by operators.
Completed Date	`completedDate`	`string`	Completed date in ISO 8601 format. Can only be set by operators.
Closed	`closed`	`boolean`	Whether the incident is closed. Can only be set by operators.
Closed Date	`closedDate`	`string`	Closed date in ISO 8601 format. Can only be set by operators.
Closure Code ID	`closureCodeId`	`string`	Select a value from the drop down menu.
Major Call	`majorCall`	`boolean`	Whether the incident is a major call. Can only be set by operators.
Publish To SSD	`publishToSsd`	`boolean`	Whether to publish the incident to Self Service Desk. Can only be set by operators.
Optional Fields 1	`optionalFields1`	`object`	Optional fields tab 1 as a JSON object
Optional Fields 2	`optionalFields2`	`object`	Optional fields tab 2 as a JSON object

Action Authentication#

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

About TOPdesk#

IT Service Management Platform

More Ways to Connect TOPdesk + Acuity Scheduling#

Other Popular Integrations#

Create Incident with TOPdesk API on New Appointment Canceled (Instant) from Acuity Scheduling API

Acuity Scheduling + TOPdesk

Try it

Create Incident with TOPdesk API on New Appointment Rescheduled (Instant) from Acuity Scheduling API

Acuity Scheduling + TOPdesk

Try it

Get Incident with TOPdesk API on New Appointment Canceled (Instant) from Acuity Scheduling API

Acuity Scheduling + TOPdesk

Try it

Get Incident with TOPdesk API on New Appointment Rescheduled (Instant) from Acuity Scheduling API

Acuity Scheduling + TOPdesk

Try it

Get Incident with TOPdesk API on New Appointment (Instant) from Acuity Scheduling API

Acuity Scheduling + TOPdesk

Try it

Popular Triggers#

New Appointment (Instant) from the Acuity Scheduling API

Emit new event when an appointment is scheduled.

Try it

New Appointment Canceled (Instant) from the Acuity Scheduling API

Emit new event when an appointment is canceled.

Try it

New Appointment Rescheduled (Instant) from the Acuity Scheduling API

Emit new event when an appointment is rescheduled.

Try it

Popular Actions#

Add Blocked Off Time with the Acuity Scheduling API

Blocks a specific time slot on your schedule to prevent the scheduling of any appointments during this particular time range. See the documentation

Try it

Book Appointment with the Acuity Scheduling API

Book an appointment. See the documentation

Try it

Check Availability Times with the Acuity Scheduling API

Validate available times for an appointment. See the documentation

Try it

Find Appointments by Client Info with the Acuity Scheduling API

Retrieves existing appointments using the client's information, allowing you to track all the appointments associated with a specific client. See the documentation

Try it

Get Appointment Types with the Acuity Scheduling API

Return a list ofappointment types. See the documentation

Try it