Create Incident with TOPdesk API on New Requests (Payload Only) from HTTP / Webhook API

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

Trigger workflow on

New Requests (Payload Only) from the HTTP / Webhook 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 HTTP / Webhook 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 Requests (Payload Only) trigger
1. Connect your HTTP / Webhook 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 Requests (Payload Only) on HTTP / Webhook

Description:Get a URL and emit the HTTP body as an event on every request

Version:0.1.1

Key:http-new-requests-payload-only

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

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

// Core HTTP component
// Returns a 200 OK response, emits the HTTP payload as an event
export default {
  key: "http-new-requests-payload-only",
  name: "New Requests (Payload Only)",
  // eslint-disable-next-line
  description: "Get a URL and emit the HTTP body as an event on every request",
  version: "0.1.1",
  type: "source",
  props: {
    // eslint-disable-next-line
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    http,
  },
  async run(event) {
    const { body } = event;
    this.httpInterface.respond({
      status: 200,
      body,
    });
    // Emit the HTTP payload
    this.$emit({
      body,
    });
  },
};

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
N/A	`httpInterface`	`$.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.
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

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 + HTTP / Webhook#

Other Popular Integrations#

Create Incident with TOPdesk API on New Requests from HTTP / Webhook API

HTTP / Webhook + TOPdesk

Try it

Get Incident with TOPdesk API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + TOPdesk

Try it

Get Incident with TOPdesk API on New Requests from HTTP / Webhook API

HTTP / Webhook + TOPdesk

Try it

Get Incidents with TOPdesk API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + TOPdesk

Try it

Get Incidents with TOPdesk API on New Requests from HTTP / Webhook API

HTTP / Webhook + TOPdesk

Try it

Popular Triggers#

New Requests from the HTTP / Webhook API

Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Try it

New Requests (Payload Only) from the HTTP / Webhook API

Get a URL and emit the HTTP body as an event on every request

Try it

New event when the content of the URL changes. from the HTTP / Webhook API

Emit new event when the content of the URL changes.

Try it