Create Request with Jira Service Desk API

Pipedream makes it easy to connect APIs for Jira Service Desk and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Request with the Jira Service Desk 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#

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

Configure the Create Request action
1. Connect your Jira Service Desk account
2. Select a Cloud ID
3. Select a Service Desk ID
4. Select a Request Type ID
5. Optional- Configure Request Participants
6. Optional- Configure Raise On Behalf Of
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Request with Jira Service Desk API on Webhook Destination (Instant) from Segment API

Segment + Jira Service Desk

Try it

Create Request with Jira Service Desk API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Jira Service Desk

Try it

Create Request with Jira Service Desk API on New Submission from Typeform API

Typeform + Jira Service Desk

Try it

Create Request with Jira Service Desk API on Custom Events from Zoom API

Zoom + Jira Service Desk

Try it

Create Request with Jira Service Desk API on New Submission (Instant) from Jotform API

Jotform + Jira Service Desk

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 Request on Jira Service Desk

Description:Creates a new customer request. [See the documentation](https://docs.atlassian.com/jira-servicedesk/REST/3.6.2/#servicedeskapi/request-createCustomerRequest)

Version:0.1.0

Key:jira_service_desk-create-request

View on GitHub

Code#

import jiraServiceDesk from "../../jira_service_desk.app.mjs";

export default {
  key: "jira_service_desk-create-request",
  name: "Create Request",
  description:
    "Creates a new customer request. [See the documentation](https://docs.atlassian.com/jira-servicedesk/REST/3.6.2/#servicedeskapi/request-createCustomerRequest)",
  version: "0.1.0",
  type: "action",
  props: {
    jiraServiceDesk,
    cloudId: {
      propDefinition: [
        jiraServiceDesk,
        "cloudId",
      ],
    },
    serviceDeskId: {
      propDefinition: [
        jiraServiceDesk,
        "serviceDeskId",
        ({ cloudId }) => ({
          cloudId,
        }),
      ],
    },
    requestTypeId: {
      propDefinition: [
        jiraServiceDesk,
        "requestTypeId",
        ({
          cloudId, serviceDeskId,
        }) => ({
          cloudId,
          serviceDeskId,
        }),
      ],
      reloadProps: true,
    },
    requestParticipants: {
      type: "string[]",
      label: "Request Participants",
      description:
        "Not available to users who only have the Service Desk Customer permission or if the feature is turned off for customers..",
      optional: true,
    },
    raiseOnBehalfOf: {
      type: "string",
      label: "Raise On Behalf Of",
      description:
        "Not available to users who only have the Service Desk Customer permission.",
      optional: true,
    },
  },
  async additionalProps() {
    const {
      cloudId, serviceDeskId, requestTypeId,
    } = this;
    const types = await this.jiraServiceDesk.getRequestTypeFields({
      cloudId,
      serviceDeskId,
      requestTypeId,
    });

    return Object.fromEntries(
      types.map((field) => [
        field.fieldId,
        {
          type: "string",
          label: `Field: "${field.name}"`,
          description: `[See the documentation](https://docs.atlassian.com/jira-servicedesk/REST/3.6.2/#fieldformats) for info on specific fields. If the provided value is not a string, it will be parsed as JSON.${field.description
            ? `
\\
Field description: "${field.description}"`
            : ""}${field.jiraSchema
            ? `
  \\
  Field schema: \`${JSON.stringify(field.jiraSchema)}\``
            : ""}`,
          optional: !field.required,
        },
      ]),
    );
  },
  async run({ $ }) {
    const {
      // eslint-disable-next-line no-unused-vars
      jiraServiceDesk,
      cloudId,
      serviceDeskId,
      requestTypeId,
      requestParticipants,
      raiseOnBehalfOf,
      ...requestFieldValues
    } = this;

    Object.entries(requestFieldValues).forEach(([
      key,
      value,
    ]) => {
      try {
        const parsedValue = JSON.parse(value);
        requestFieldValues[key] = parsedValue;
      }
      catch (err) {
        // ignore non-serializable values
      }
    });

    const response = await this.jiraServiceDesk.createCustomerRequest({
      $,
      cloudId,
      data: {
        serviceDeskId,
        requestTypeId,
        requestFieldValues,
        requestParticipants,
        raiseOnBehalfOf,
      },
    });
    $.export("$summary", "Successfully created request");
    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.

Label	Prop	Type	Description
Jira Service Desk	`jiraServiceDesk`	`app`	This component uses the Jira Service Desk app.
Cloud ID	`cloudId`	`string`	Select a value from the drop down menu.
Service Desk ID	`serviceDeskId`	`string`	Select a value from the drop down menu.
Request Type ID	`requestTypeId`	`string`	Select a value from the drop down menu.
Request Participants	`requestParticipants`	`string[]`	Not available to users who only have the Service Desk Customer permission or if the feature is turned off for customers..
Raise On Behalf Of	`raiseOnBehalfOf`	`string`	Not available to users who only have the Service Desk Customer permission.

Authentication#

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

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

read:servicedesk-requestmanage:servicedesk-customerwrite:servicedesk-requestread:jira:userread:jira-workread:organization:jira-service-managementread:meoffline_access