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

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

Trigger workflow on

Webhook Destination (Instant) from the Segment API

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#

This integration creates a workflow with a Segment trigger and Jira Service Desk action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Webhook Destination (Instant) trigger
1. Connect your Segment account
2. Select a Workspace
3. Select a Source
4. Configure Name
5. Optional- Configure Trigger
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
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#

Webhook Destination (Instant) on Segment

Description:Send events to a webhook. Requires a Team or Business account.

Version:0.0.2

Key:segment-webhook-destination

View on GitHub

Segment Overview#

The Segment API enables you to collect, manage, and route your customer analytics data to various tools for marketing, analytics, and data warehousing. By harnessing the Segment API on Pipedream, you can automate the ingestion and syncing of user events and properties to multiple destinations, allowing you to create seamless data pipelines without manual intervention. Pipedream's serverless platform empowers you to build custom workflows that react to events in real-time, enrich data, or trigger actions across your tech stack.

Trigger Code#

import segmentApp from "../../segment.app.mjs";

export default {
  key: "segment-webhook-destination",
  name: "Webhook Destination (Instant)",
  description: "Send events to a webhook. Requires a Team or Business account.",
  version: "0.0.2",
  type: "source",
  props: {
    segmentApp,
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    workspace: {
      propDefinition: [
        segmentApp,
        "workspace",
      ],
    },
    source: {
      propDefinition: [
        segmentApp,
        "source",
        ({ workspace }) => ({
          workspace,
        }),
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "Defines the display name of the Destination",
    },
    trigger: {
      type: "string",
      label: "Trigger",
      description: "Destination FQL Statement. [Filter Query Language](https://segment.com/docs/api/public-api/fql/)",
      optional: true,
      default: "type = \"identify\" or type = \"track\" or type = \"group\"",
    },
  },
  hooks: {
    async activate() {
      const { data } = await this.segmentApp.createDestination({
        data: {
          sourceId: this.source,
          metadataId: await this.findMetadataId(),
          name: this.name,
          enabled: true,
          connection_mode: "UNSPECIFIED",
          settings: {},
        },
      });
      const destinationId = data.destination.id;
      this.setDestinationId(destinationId);

      const response = await this.segmentApp.createDestinationSubscription({
        destination: destinationId,
        data: {
          name: "Pipedream Webhook Subscription",
          trigger: this.trigger,
          actionId: await this.findActionId(destinationId),
          enabled: true,
          settings: {
            method: "POST",
            url: this.http.endpoint,
          },
        },
      });
      const subscriptionId = response.data.destinationSubscription.id;
      this.setSubscriptionId(subscriptionId);
    },
    async deactivate() {
      const destination = this.getDestinationId();
      const subscription = this.getSubscriptionId();
      await this.segmentApp.deleteDestinationSubscription({
        destination,
        subscription,
      });
      await this.segmentApp.deleteDestination({
        destination,
      });
    },
  },
  methods: {
    getDestination() {
      return "actions-webhook";
    },
    setDestinationId(id) {
      this.db.set("destinationId", id);
    },
    getDestinationId() {
      return this.db.get("destinationId");
    },
    setSubscriptionId(id) {
      this.db.set("subscriptionId", id);
    },
    getSubscriptionId() {
      return this.db.get("subscriptionId");
    },
    async findDestinationMetadataId() {
      const params = {
        pagination: {
          count: 200,
        },
      };
      do {
        const {
          data: {
            destinationsCatalog, pagination,
          },
        } = await this.segmentApp.getDestinationsCatalog({
          params,
        });
        const destination = destinationsCatalog.find(({ slug }) => slug === this.getDestination());
        if (destination) {
          return destination.id;
        }
        params.pagination.cursor = pagination?.next;
      } while (params.pagination.cursor);
    },
    async findMetadataId() {
      const destinationMetadataId = await this.findDestinationMetadataId();
      const { data: { destinationMetadata } } =  await this.segmentApp.getDestinationMetadata({
        destinationMetadataId,
      });
      if (!destinationMetadata?.id) {
        throw new Error(`MetadataId for ${this.getDestination()} not found.`);
      }
      return destinationMetadata.id;
    },
    async findActionId(destination) {
      const { data } = await this.segmentApp.getDestination({
        destination,
      });
      return data.destination.metadata.actions[0].id;
    },
  },
  async run(event) {
    this.http.respond({
      status: 200,
    });

    this.$emit(event, {
      id: Date.now(),
      summary: "Received event",
      ts: Date.now(),
    });
  },
};

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
Segment	`segmentApp`	`app`	This component uses the Segment app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.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.
Workspace	`workspace`	`string`	Select a value from the drop down menu.
Source	`source`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Defines the display name of the Destination
Trigger	`trigger`	`string`	Destination FQL Statement. Filter Query Language

Trigger Authentication#

Segment uses API keys for authentication. When you connect your Segment account, Pipedream securely stores the keys so you can easily authenticate to Segment APIs in both code and no-code steps.

Segment's APIs are accessed programmatically using access tokens, as well as write keys.

Access Token

Create access tokens via the Access Management page in your account: https://app.segment.com/{your-workspace-name}/settings/access-management. See "Get a Token" for more details. Please note, that you must be on a Team or Business plan to create an access token.

Write Key

You will also need to find your write key, which is a unique identifier for your Source. To find a write key, you first need to create a non-Cloud Source such as a website, server, or mobile source. (Cloud-sources do not have write keys, as they use a token or key from your account with that service.) Then, in the Source, go to “Settings’, and then go to “API Keys”. See "Locating Your Write Key" for more details.

About Segment#

Customer data platform

Action#

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

Jira Service Desk Overview#

The Jira Service Desk API allows you to interact programmatically with your support ticket system, enabling the creation, updating, and management of tickets, customers, and service desk configurations. With Pipedream's integration, you can automate workflows by connecting Jira Service Desk to hundreds of other apps, listen to webhooks for real-time triggers, and execute custom logic.

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

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
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.

Action 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

About Jira Service Desk#

Work with Jira Service Desk-specific entities, such as requests.

More Ways to Connect Jira Service Desk + Segment#

Other Popular Integrations#

Associate one identity with another with Segment API on New Request Created from Jira Service Desk API

Jira Service Desk + Segment

Try it

Associate an identified user with a group with Segment API on New Request Created from Jira Service Desk API

Jira Service Desk + Segment

Try it

Identify a user, tie them to their actions and record traits about them with Segment API on New Request Created from Jira Service Desk API

Jira Service Desk + Segment

Try it

Record page views on your website with Segment API on New Request Created from Jira Service Desk API

Jira Service Desk + Segment

Try it

Record whenever a user sees a screen with Segment API on New Request Created from Jira Service Desk API

Jira Service Desk + Segment

Try it

Popular Triggers#

Webhook Destination (Instant) from the Segment API

Send events to a webhook. Requires a Team or Business account.

Try it

New Request Created from the Jira Service Desk API

Emit new event when a customer request is created. See the documentation

Try it

Request Status Updated from the Jira Service Desk API

Emit new event when a customer request is updated. See the documentation

Try it

Popular Actions#

Associate an identified user with a group with the Segment API

Group lets you associate an identified user with a group (note requires userId or anonymousId). See the docs here

Try it

Associate one identity with another with the Segment API

Alias is how you associate one identity with another. See the docs here

Try it

Identify a user, tie them to their actions and record traits about them with the Segment API

Identify lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them (note requires userId or anonymousId). See the docs here

Try it

Record page views on your website with the Segment API

The page method lets you record page views on your website, along with optional extra information about the page being viewed (note requires userId or anonymousId). See the docs here

Try it

Record whenever a user sees a screen with the Segment API

The screen method let you record whenever a user sees a screen of your mobile app (note requires userId or anonymousId). See the docs here

Try it