Create Incident with LinearB API on New Deploy Started from DeployHQ API

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

Trigger workflow on

New Deploy Started from the DeployHQ API

Next, do this

Create Incident with the LinearB 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 DeployHQ trigger and LinearB action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Deploy Started trigger
1. Connect your DeployHQ account
Configure the Create Incident action
1. Connect your LinearB account
2. Configure Provider ID
3. Configure HTTP URL
4. Configure Title
5. Configure Issued At
6. Optional- Configure Started At
7. Optional- Configure Ended At
8. Optional- Configure Git Ref
9. Optional- Select one or more Teams
10. Optional- Select one or more Services
11. Optional- Configure Repository URLs
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 Deploy Started on DeployHQ

Description:Emit new event when a deploy starts

Version:0.0.2

Key:deployhq-deploy-started

View on GitHub

DeployHQ Overview#

DeployHQ is a service that automates the deployment of your web applications. By integrating with version control systems, DeployHQ can automatically deploy code changes to various environments. Using the DeployHQ API on Pipedream, you can orchestrate deployments, manage your projects, and synchronize deployment activities with other tools in your toolchain. It opens up possibilities for custom deployment workflows, notifications, monitoring, and more, all connected within the Pipedream ecosystem.

Trigger Code#

import common, { STATUS_RUNNING } from "../common.mjs";

export default {
  ...common,
  key: "deployhq-deploy-started",
  name: "New Deploy Started",
  version: "0.0.2",
  description: "Emit new event when a deploy starts",
  type: "source",
  async run(request) {
    const { payload } = this.validateRequest(request);

    if (payload.status !== STATUS_RUNNING) {
      console.log(`Deploy status [${payload.status}] is not ${STATUS_RUNNING}`);
      return;
    }

    this.$emit({
      payload,
    }, {
      id: payload.identifier,
      summary: `Started ${payload.identifier}`,
      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
DeployHQ	`deployHq`	`app`	This component uses the DeployHQ app.
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.

Trigger Authentication#

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

DeployHQ requires their users enter their email, API Key, and account name in order to connect to their API. For more info, refer to DeployHQ’s documentation.

To retrieve your API key,

Navigate to your DeployHQ account and sign in
Go to “Settings” > “Security”

Your account name is 1234 if your DeployHQ URL is https://1234.deployhq.com

About DeployHQ#

Deployment made simple. We make it super easy to automate deploying projects from Git, SVN and Mercurial repositories.

Action#

Create Incident on LinearB

Description:Create a new incident within the LinearB platform. [See the documentation](https://docs.linearb.io/api-incidents/#create-incident)

Version:0.0.3

Key:linearb-create-incident

View on GitHub

LinearB Overview#

The LinearB API serves as a bridge between LinearB's project management insights and your preferred platforms, offering the ability to automate workflows, generate reports, and trigger actions based on project metrics. With Pipedream, these capabilities can be harnessed to create custom workflows that respond to events within LinearB, such as changes in project status or team performance metrics. The data can be pushed to various services, such as communication tools, databases, or other project management apps to enhance visibility and coordination across your team.

Action Code#

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

export default {
  key: "linearb-create-incident",
  name: "Create Incident",
  description: "Create a new incident within the LinearB platform. [See the documentation](https://docs.linearb.io/api-incidents/#create-incident)",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    providerId: {
      type: "string",
      label: "Provider ID",
      description: "The unique identifier of the incident in your incident management provider. Eg. `provider_internal_id1`",
    },
    httpUrl: {
      type: "string",
      label: "HTTP URL",
      description: "The URL of your incident management provider. The combination `http_url/provider_key` should open the incident in your PM provider. Eg. `http://myprovider.io/1`",
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the incident",
    },
    issuedAt: {
      type: "string",
      label: "Issued At",
      description: "The specific time when the incident was logged and officially opened. (timestamp ISO 8601 format). Eg. `2019-09-26T07:58:30.996`",
    },
    startedAt: {
      type: "string",
      label: "Started At",
      description: "The specific time when work on the incident commenced. (timestamp ISO 8601 format). Eg. `2019-09-26T07:58:30.996`",
      optional: true,
    },
    endedAt: {
      type: "string",
      label: "Ended At",
      description: "The specific time when the incident was successfully resolved. (timestamp ISO 8601 format). Eg. `2019-09-26T07:58:30.996`",
      optional: true,
    },
    gitRef: {
      type: "string",
      label: "Git Ref",
      description: "The Git reference of the release responsible for causing this incident, Eg. commit short or long sha or tag name (Eg. commit short or long sha/tag name).",
      optional: true,
    },
    teams: {
      propDefinition: [
        app,
        "teams",
      ],
      optional: true,
    },
    services: {
      propDefinition: [
        app,
        "services",
      ],
      optional: true,
    },
    repositoryUrls: {
      type: "string[]",
      label: "Repository URLs",
      description: "The list of repos urls related to this incident. Eg. `https://github.com/myorg/repo1.git`",
      optional: true,
    },
  },
  methods: {
    createIncident(args = {}) {
      return this.app.post({
        path: "/incidents",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createIncident,
      providerId,
      httpUrl,
      title,
      issuedAt,
      startedAt,
      endedAt,
      gitRef,
      teams,
      services,
      repositoryUrls,
    } = this;

    const response = await createIncident({
      $,
      data: {
        provider_id: providerId,
        http_url: httpUrl,
        title,
        issued_at: issuedAt,
        started_at: startedAt,
        ended_at: endedAt,
        git_ref: gitRef,
        teams,
        services,
        repository_urls: repositoryUrls,
      },
    });

    $.export("$summary", "Successfully created incident");
    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
LinearB	`app`	`app`	This component uses the LinearB app.
Provider ID	`providerId`	`string`	The unique identifier of the incident in your incident management provider. Eg. `provider_internal_id1`
HTTP URL	`httpUrl`	`string`	The URL of your incident management provider. The combination `http_url/provider_key` should open the incident in your PM provider. Eg. `http://myprovider.io/1`
Title	`title`	`string`	The title of the incident
Issued At	`issuedAt`	`string`	The specific time when the incident was logged and officially opened. (timestamp ISO 8601 format). Eg. `2019-09-26T07:58:30.996`
Started At	`startedAt`	`string`	The specific time when work on the incident commenced. (timestamp ISO 8601 format). Eg. `2019-09-26T07:58:30.996`
Ended At	`endedAt`	`string`	The specific time when the incident was successfully resolved. (timestamp ISO 8601 format). Eg. `2019-09-26T07:58:30.996`
Git Ref	`gitRef`	`string`	The Git reference of the release responsible for causing this incident, Eg. commit short or long sha or tag name (Eg. commit short or long sha/tag name).
Teams	`teams`	`string[]`	Select a value from the drop down menu.
Services	`services`	`string[]`	Select a value from the drop down menu.
Repository URLs	`repositoryUrls`	`string[]`	The list of repos urls related to this incident. Eg. `https://github.com/myorg/repo1.git`