← TOPdesk

Create Incident with TOPdesk API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Incident with the TOPdesk API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create Incident with the TOPdesk API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Incident with TOPdesk API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + TOPdesk
 
Try it
Create Incident with TOPdesk API on New Submission from Typeform API
Typeform + TOPdesk
 
Try it
Create Incident with TOPdesk API on New Submission (Instant) from Jotform API
Jotform + TOPdesk
 
Try it
Create Incident with TOPdesk API on New Scheduled Tasks from Pipedream API
Pipedream + TOPdesk
 
Try it
Create Incident with TOPdesk API on New Download Counts from npm API
npm + TOPdesk
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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.
LabelPropTypeDescription
TOPdeskappappThis component uses the TOPdesk app.
Caller Lookup IDcallerLookupIdstringSelect a value from the drop down menu.
StatusstatusstringSelect a value from the drop down menu:firstLinesecondLinepartial
Brief DescriptionbriefDescriptionstring

Brief description of the incident (max 80 characters)

Requestrequeststring

The initial request text. HTML tags are supported: <i>, <em>, <b>, <strong>, <u>, <br>, <h5>, <h6>

Actionactionstring

The action text to add. HTML tags are supported: <i>, <em>, <b>, <strong>, <u>, <br>, <h5>, <h6>

Action Invisible For CalleractionInvisibleForCallerboolean

Whether the action is invisible for persons. Can only be set by operators.

Category IDcategoryIdstringSelect a value from the drop down menu.
Subcategory IDsubcategoryIdstringSelect a value from the drop down menu.
Call Type IDcallTypeIdstringSelect a value from the drop down menu.
Entry Type IDentryTypeIdstringSelect a value from the drop down menu.
External NumberexternalNumberstring

External number (max 60 characters). Can only be set by operators.

Object NameobjectNamestringSelect a value from the drop down menu.
Location IDlocationIdstringSelect a value from the drop down menu.
Branch IDbranchIdstringSelect a value from the drop down menu.
Main Incident IDmainIncidentIdstring

Main incident UUID, required for creating a partial incident. Can only be set by operators.

Impact IDimpactstringSelect a value from the drop down menu.
Urgency IDurgencystringSelect a value from the drop down menu.
Priority IDprioritystringSelect a value from the drop down menu.
Duration IDdurationstringSelect a value from the drop down menu.
Target DatetargetDatestring

Target date in ISO 8601 format (e.g., 2024-08-01T12:00:00.000+0200). Can only be set by operators.

SLA IDslaIdstringSelect a value from the drop down menu.
On HoldonHoldboolean

Whether the incident is on hold. Can only be set by operators.

OperatoroperatorIdstringSelect a value from the drop down menu.
Operator Group IDoperatorGroupIdstringSelect a value from the drop down menu.
Supplier IDsupplierIdstringSelect a value from the drop down menu.
Processing Status IDprocessingStatusIdstringSelect a value from the drop down menu.
Respondedrespondedboolean

Whether the incident is responded. SLM-licence is needed. Can only be set by operators.

Response DateresponseDatestring

Response date in ISO 8601 format. SLM-licence is needed. Can only be set by operators.

Completedcompletedboolean

Whether the incident is completed. Can only be set by operators.

Completed DatecompletedDatestring

Completed date in ISO 8601 format. Can only be set by operators.

Closedclosedboolean

Whether the incident is closed. Can only be set by operators.

Closed DateclosedDatestring

Closed date in ISO 8601 format. Can only be set by operators.

Closure Code IDclosureCodeIdstringSelect a value from the drop down menu.
Major CallmajorCallboolean

Whether the incident is a major call. Can only be set by operators.

Publish To SSDpublishToSsdboolean

Whether to publish the incident to Self Service Desk. Can only be set by operators.

Optional Fields 1optionalFields1object

Optional fields tab 1 as a JSON object

Optional Fields 2optionalFields2object

Optional fields tab 2 as a JSON object

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 Use TOPdesk

Actions

Get Incident with the TOPdesk API

Returns an incident by ID. See the documentation

 
Try it
Get Incidents with the TOPdesk API

Returns a list of incidents. See the documentation

 
Try it
Get Knowledge Item Statuses with the TOPdesk API

Returns the list of possible Knowledge Item statuses. See the documentation

 
Try it
Get Knowledge Items with the TOPdesk API

Returns a list of Knowledge Items. See the documentation

 
Try it
Update Incident with the TOPdesk API

Updates an existing incident. See the documentation

 
Try it

Explore Other Apps

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

Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Notion
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.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Anthropic (Claude)
Anthropic (Claude)
AI research and products that put safety at the frontier. Introducing Claude, a next-generation AI assistant for your tasks, no matter the scale.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Telegram
Telegram
Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
Shopify
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.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Slack
Slack
Slack is the AI-powered platform for work bringing all of your conversations, apps, and customers together in one place. Around the world, Slack is helping businesses of all sizes grow and send productivity through the roof.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.