Create Incident with TOPdesk API on New or Updated Page in Data Source (By Property) from Notion API

Pipedream makes it easy to connect APIs for TOPdesk, Notion and 3,000+ other apps remarkably fast.

Trigger workflow on

New or Updated Page in Data Source (By Property) from the Notion 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 Notion 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 or Updated Page in Data Source (By Property) trigger
1. Connect your Notion account
2. Configure timer
3. Select a Data Source ID
4. Configure Include New Pages
5. Optional- Select one or more Property Types
6. Configure alert
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 or Updated Page in Data Source (By Property) on Notion

Description:Emit new event when a page is created or updated in the selected data source. [See the documentation](https://developers.notion.com/reference/page)

Version:1.0.1

Key:notion-updated-page

View on GitHub

Notion Overview#

Notion's API allows for the creation, reading, updating, and deleting of pages, databases, and their contents within Notion. Using Pipedream's platform, you can build workflows that connect Notion with various other services to automate tasks such as content management, task tracking, and data synchronization. With Pipedream's serverless execution, you can trigger these workflows on a schedule, or by external events from other services, without managing any infrastructure.

Trigger Code#

import zlib from "zlib";
import notion from "../../notion.app.mjs";
import base from "../common/base.mjs";
import constants from "../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...base,
  key: "notion-updated-page",
  name: "New or Updated Page in Data Source (By Property)",
  description: "Emit new event when a page is created or updated in the selected data source. [See the documentation](https://developers.notion.com/reference/page)",
  version: "1.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...base.props,
    dataSourceId: {
      propDefinition: [
        notion,
        "dataSourceId",
      ],
    },
    includeNewPages: {
      type: "boolean",
      label: "Include New Pages",
      description: "Set to `false` to emit events only for updates, not for new pages.",
      default: true,
    },
    properties: {
      propDefinition: [
        notion,
        "propertyTypes",
        (c) => ({
          parentId: c.dataSourceId,
          parentType: "data_source",
        }),
      ],
      description: "Only emit events when one or more of the selected properties have changed",
      optional: true,
    },
    alert: {
      type: "alert",
      alertType: "warning",
      content: "Source not saving? Your database might be too large. If deployment takes longer than one minute, an error will occur.",
    },
  },
  hooks: {
    async activate() {
      console.log("Activating: fetching pages and properties");
      this._setLastUpdatedTimestamp(Date.now());
      const propertyValues = {};
      const propertiesToCheck = await this._getPropertiesToCheck();
      const params = this.lastUpdatedSortParam();
      const pagesStream = this.notion.getPages(this.dataSourceId, params);
      for await (const page of pagesStream) {
        for (const propertyName of propertiesToCheck) {
          const currentValue = this._maybeRemoveFileSubItems(page.properties[propertyName]);
          propertyValues[page.id] = {
            ...propertyValues[page.id],
            [propertyName]: currentValue,
          };
        }
      }
      this._setPropertyValues(propertyValues);
    },
    async deactivate() {
      console.log("Deactivating: clearing states");
      this._setLastUpdatedTimestamp(null);
    },
  },
  methods: {
    ...base.methods,
    _getLastUpdatedTimestamp() {
      return this.db.get(constants.timestamps.LAST_EDITED_TIME);
    },
    _setLastUpdatedTimestamp(ts) {
      this.db.set(constants.timestamps.LAST_EDITED_TIME, ts);
    },
    _getPropertyValues() {
      const compressed = this.db.get("propertyValues");
      const buffer = Buffer.from(compressed, "base64");
      const decompressed = zlib.inflateSync(buffer).toString();
      return JSON.parse(decompressed);
    },
    _setPropertyValues(propertyValues) {
      const string = JSON.stringify(propertyValues);
      const compressed = zlib.deflateSync(string).toString("base64");
      this.db.set("propertyValues", compressed);
    },
    async _getPropertiesToCheck() {
      if (this.properties?.length) {
        return this.properties;
      }
      const { properties } = await this.notion.retrieveDataSource(this.dataSourceId);
      return Object.keys(properties);
    },
    _maybeRemoveFileSubItems(property) {
      // Files & Media type:
      // `url` and `expiry_time` are constantly updated by Notion, so ignore these fields
      if (property.type === "files") {
        const modified = structuredClone(property);
        for (const file of modified.files) {
          if (file.type === "file") {
            delete file.file;
          }
        }
        return modified;
      }
      return property;
    },
    _generateMeta(obj, summary) {
      const { id } = obj;
      const title = this.notion.extractPageTitle(obj);
      const ts = Date.now();
      return {
        id: `${id}-${ts}`,
        summary: `${summary}: ${title}`,
        ts,
      };
    },
    _emitEvent(page, changes = [], isNewPage = true) {
      const meta = isNewPage
        ? this._generateMeta(page, constants.summaries.PAGE_ADDED)
        : this._generateMeta(page, constants.summaries.PAGE_UPDATED);
      const event = {
        page,
        changes,
      };
      this.$emit(event, meta);
    },
  },
  async run() {
    const lastCheckedTimestamp = this._getLastUpdatedTimestamp();
    const propertyValues = this._getPropertyValues();

    if (!lastCheckedTimestamp) {
      // recently updated (deactivated / activated), skip execution
      console.log("Awaiting restart completion: skipping execution");
      return;
    }

    const params = {
      ...this.lastUpdatedSortParam(),
      filter: {
        timestamp: "last_edited_time",
        last_edited_time: {
          on_or_after: new Date(lastCheckedTimestamp).toISOString(),
        },
      },
    };
    let newLastUpdatedTimestamp = lastCheckedTimestamp;
    const propertiesToCheck = await this._getPropertiesToCheck();
    const pagesStream = this.notion.getPages(this.dataSourceId, params);

    for await (const page of pagesStream) {
      const changes = [];
      let isNewPage = false;
      let propertyHasChanged = false;

      newLastUpdatedTimestamp = Math.max(
        newLastUpdatedTimestamp,
        Date.parse(page.last_edited_time),
      );

      if (lastCheckedTimestamp > Date.parse(page.last_edited_time)) {
        break;
      }

      // Check if this is a new page first
      const pageExistsInDB = propertyValues[page.id] != null;
      isNewPage = !pageExistsInDB;

      for (const propertyName of propertiesToCheck) {
        const previousValue = structuredClone(propertyValues[page.id]?.[propertyName]);
        // value used to compare and to save to this.db
        const currentValueToSave = this._maybeRemoveFileSubItems(page.properties[propertyName]);
        // (unmodified) value that should be emitted
        const currentValueToEmit = page.properties[propertyName];

        const propertyChanged =
          JSON.stringify(previousValue) !== JSON.stringify(currentValueToSave);

        if (pageExistsInDB && propertyChanged) {
          propertyHasChanged = true;
          propertyValues[page.id] = {
            ...propertyValues[page.id],
            [propertyName]: currentValueToSave,
          };
          changes.push({
            property: propertyName,
            previousValue,
            currentValue: currentValueToEmit,
          });
        }

        if (!pageExistsInDB) {
          // For new pages, always track the properties
          if (!propertyValues[page.id]) {
            propertyValues[page.id] = {};
          }
          propertyValues[page.id][propertyName] = currentValueToSave;

          // Only mark as changed (to emit event) if includeNewPages is true
          if (this.includeNewPages) {
            propertyHasChanged = true;
            changes.push({
              property: propertyName,
              previousValue,
              currentValue: currentValueToEmit,
            });
          }
        }
      }

      // Only emit events if:
      // 1. It's an existing page with changes, OR
      // 2. It's a new page and includeNewPages is true
      if (propertyHasChanged && (!isNewPage || this.includeNewPages)) {
        this._emitEvent(page, changes, isNewPage);
      }
    }

    this._setLastUpdatedTimestamp(newLastUpdatedTimestamp);
    this._setPropertyValues(propertyValues);
  },
  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
Notion	`notion`	`app`	This component uses the Notion app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Data Source ID	`dataSourceId`	`string`	Select a value from the drop down menu.
Include New Pages	`includeNewPages`	`boolean`	Set to `false` to emit events only for updates, not for new pages.
Property Types	`properties`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

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

About Notion#

Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.

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

Create Incident with TOPdesk API on New or Updated Page in Data Source (By Property) from Notion API

Pipedream makes it easy to connect APIs for TOPdesk, Notion and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular