Get Incidents with TOPdesk API on New Package Version from npm API

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

Trigger workflow on

New Package Version from the npm API

Next, do this

Get Incidents 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 npm 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 Package Version trigger
1. Connect your npm account
2. Configure timer
3. Configure Package
Configure the Get Incidents action
1. Connect your TOPdesk account
2. Optional- Configure Max Results
3. Optional- Configure Sort
4. Optional- Configure Query
5. Optional- Configure Fields
6. Optional- Configure 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 Package Version on npm

Description:Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)

Version:0.0.1

Key:npm-new-package-version

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import app from "../../npm.app.mjs";

export default {
  key: "npm-new-package-version",
  name: "New Package Version",
  description: "Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      default: "@pipedream/platform",
    },
  },
  async run() {
    const {
      app,
      packageName,
    } = this;

    const response = await app.getPackageMetadata({
      debug: true,
      packageName,
    });

    const { "dist-tags": { latest: latestVersion } } = response;

    this.$emit(response, {
      id: latestVersion,
      summary: `New Package Version ${latestVersion}`,
      ts: Date.parse(response.modified),
    });
  },
};

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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Get Incidents on TOPdesk

Description:Returns a list of incidents. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/getIncidents)

Version:0.0.1

Key:topdesk-get-incidents

View on GitHub

Action Code#

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

export default {
  key: "topdesk-get-incidents",
  name: "Get Incidents",
  description: "Returns a list of incidents. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/getIncidents)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "Maximum number of incidents to return. Leave empty to return all incidents.",
      optional: true,
    },
    sort: {
      type: "string",
      label: "Sort",
      description: "The sort order of the returned incidents (e.g., `callDate:asc,creationDate:desc`)",
      optional: true,
    },
    query: {
      type: "string",
      label: "Query",
      description: "A FIQL string to select which incidents should be returned. [See the documentation](https://developers.topdesk.com/tutorial.html#query)",
      optional: true,
    },
    fields: {
      type: "string",
      label: "Fields",
      description: "A comma-separated list of which fields should be returned. By default all fields will be returned.",
      optional: true,
    },
    all: {
      type: "boolean",
      label: "All",
      description: "When set to true, will return all incidents including partials and archived. Otherwise only firstLine and secondLine incidents are returned.",
      optional: true,
      default: false,
    },
  },
  annotations: {
    readOnlyHint: true,
    destructiveHint: false,
    openWorldHint: true,
    idempotentHint: true,
  },
  async run({ $ }) {
    const {
      app,
      maxResults,
      sort,
      query,
      fields,
      all,
    } = this;

    const incidents = [];
    const paginator = app.paginate({
      fn: app.listIncidents,
      fnArgs: {
        $,
        params: {
          sort,
          query,
          fields: Array.isArray(fields) && fields?.length
            ? fields.join(",")
            : typeof fields === "string" && fields.length
              ? fields
              : undefined,
          all,
          page_size: 100,
        },
      },
      maxResults,
    });

    for await (const incident of paginator) {
      incidents.push(incident);
    }

    $.export("$summary", `Successfully retrieved \`${incidents.length}\` incident(s)`);

    return incidents;
  },
};

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.
Max Results	`maxResults`	`integer`	Maximum number of incidents to return. Leave empty to return all incidents.
Sort	`sort`	`string`	The sort order of the returned incidents (e.g., `callDate:asc,creationDate:desc`)
Query	`query`	`string`	A FIQL string to select which incidents should be returned. See the documentation
Fields	`fields`	`string`	A comma-separated list of which fields should be returned. By default all fields will be returned.
All	`all`	`boolean`	When set to true, will return all incidents including partials and archived. Otherwise only firstLine and secondLine incidents are returned.