Create Request with Jira Service Desk API on New Records Returned by CloudWatch Logs Insights Query from AWS API

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

Trigger workflow on

New Records Returned by CloudWatch Logs Insights Query from the AWS 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 AWS 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 New Records Returned by CloudWatch Logs Insights Query trigger
1. Connect your AWS account
2. Select a AWS Region
3. Select one or more CloudWatch Log Groups
4. Configure Logs Insights Query
5. Optional- Configure Emit query results as a single event
6. Configure Polling schedule
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#

New Records Returned by CloudWatch Logs Insights Query on AWS

Description:Executes a CloudWatch Logs Insights query on a schedule, and emits the records as invidual events (default) or in batch

Version:0.2.2

Key:aws-new-records-returned-by-cloudwatch-logs-insights-query

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import common from "../../common/common-cloudwatch-logs.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  ...common,
  key: "aws-new-records-returned-by-cloudwatch-logs-insights-query",
  name: "New Records Returned by CloudWatch Logs Insights Query",
  // eslint-disable-next-line pipedream/source-description
  description: "Executes a CloudWatch Logs Insights query on a schedule, and emits the records as invidual events (default) or in batch",
  version: "0.2.2",
  type: "source",
  props: {
    aws: common.props.aws,
    region: common.props.region,
    db: "$.service.db",
    // eslint-disable-next-line pipedream/props-label
    logGroupNames: {
      ...common.props.logGroupName,
      type: "string[]",
      description: "The log groups you'd like to query",
    },
    queryString: {
      label: "Logs Insights Query",
      description: "The query you'd like to run. See [this AWS doc](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) for help with query syntax",
      type: "string",
    },
    emitResultsInBatch: {
      type: "boolean",
      label: "Emit query results as a single event",
      description: "If `true`, all events are emitted as an array, within a single Pipedream event. If `false`, each row of results is emitted as its own event. Defaults to `true`",
      optional: true,
      default: true,
    },
    timer: {
      label: "Polling schedule",
      description: "How often you want to query CloudWatch Logs Insights for results",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  async run() {
    const now = +new Date();
    const startTime = this.db.get("startTime") || now - 1000 * 60 * 60;

    // First, start the query
    const params = {
      queryString: this.queryString,
      startTime,
      endTime: now,
      logGroupNames: this.logGroupNames,
    };

    const { queryId } = await this.startQuery(params);

    // Then poll for its status, emitting each record as its own event when completed
    async function sleep(ms) {
      return new Promise((r) => setTimeout(r, ms));
    }

    let result, res;
    do {
      await sleep(1000);
      res = await this.getQueryResults({
        queryId,
      });
      result = res.status;
    } while (result === "Running" || result === "Scheduled");

    if (result !== "Complete") {
      throw new Error(`Query ${queryId} failed with status ${result}`);
    }

    console.log(JSON.stringify(res, null, 2));
    const { results } = res;

    if (!results || !results.length) {
      console.log("No results, exiting");
      this.db.set("startTime", now);
      return;
    }

    if (this.emitResultsInBatch === true) {
      this.$emit(results, {
        summary: JSON.stringify(results),
      });
    } else {
      for (const item of results) {
        this.$emit(item, {
          summary: JSON.stringify(item),
        });
      }
    }

    // The next time this source runs, query for data starting now
    this.db.set("startTime", 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
AWS	`aws`	`app`	This component uses the AWS app.
AWS Region	`region`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
CloudWatch Log Groups	`logGroupNames`	`string[]`	Select a value from the drop down menu.
Logs Insights Query	`queryString`	`string`	The query you'd like to run. See this AWS doc for help with query syntax
Emit query results as a single event	`emitResultsInBatch`	`boolean`	If `true`, all events are emitted as an array, within a single Pipedream event. If `false`, each row of results is emitted as its own event. Defaults to `true`
Polling schedule	`timer`	`$.interface.timer`	How often you want to query CloudWatch Logs Insights for results

Trigger Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

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 + AWS#

Other Popular Integrations#

Create Comment on Request with Jira Service Desk API on New Records Returned by CloudWatch Logs Insights Query from AWS API

AWS + Jira Service Desk

Create Request with Jira Service Desk API on New Records Returned by CloudWatch Logs Insights Query from AWS API

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

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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