Rerun Workflow with CircleCI API on New Interaction Events (Instant) from Slack API

Pipedream makes it easy to connect APIs for CircleCI, Slack and 2,400+ other apps remarkably fast.

Trigger workflow on

New Interaction Events (Instant) from the Slack API

Next, do this

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

Select this integration
Configure the New Interaction Events (Instant) trigger
1. Connect your Slack account
2. Configure alert
3. Optional- Configure Action IDs
4. Optional- Select one or more Channels
5. Configure slackApphook
Configure the Rerun Workflow action
1. Connect your CircleCI account
2. Configure Project Slug
3. Select a Pipeline ID
4. Select a Workflow ID
5. Optional- Configure Enable SSH
6. Optional- Configure From Failed
7. Optional- Select one or more Jobs
8. Optional- Configure Sparse Tree
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 Interaction Events (Instant) on Slack

Description:Emit new events on new Slack [interactivity events](https://api.slack.com/interactivity) sourced from [Block Kit interactive elements](https://api.slack.com/interactivity/components), [Slash commands](https://api.slack.com/interactivity/slash-commands), or [Shortcuts](https://api.slack.com/interactivity/shortcuts).

Version:0.0.17

Key:slack-new-interaction-event-received

View on GitHub

New Interaction Events (Instant) Overview#

Slack messages can contain interactive elements like buttons, dropdowns, radio buttons, and more. This source subscribes to interactive events, like when a button is clicked in a message.

Example of a Slack button

Then this source will be triggered when you or another Slack user in your workspace clicks a button, selects an option or fills out a form.

Example feed of interaction events coming from Slack

With this trigger, you can build workflows that perform some work with other APIs or services, and then reply back to the original message.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  name: "New Interaction Events (Instant)",
  version: "0.0.17",
  key: "slack-new-interaction-event-received",
  description: "Emit new events on new Slack [interactivity events](https://api.slack.com/interactivity) sourced from [Block Kit interactive elements](https://api.slack.com/interactivity/components), [Slash commands](https://api.slack.com/interactivity/slash-commands), or [Shortcuts](https://api.slack.com/interactivity/shortcuts).",
  type: "source",
  props: {
    ...common.props,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Please note that only messages created via Pipedream's [Send Block Kit Message](https://pipedream.com/apps/slack/actions/send-block-kit-message) Action, or via API call from the Pipedream app will emit an interaction event with this trigger. \n\nBlock kit messages sent directly via the Slack's block kit builder will not trigger an interaction event. \n\nSee the [documentation](https://pipedream.com/apps/slack/triggers/new-interaction-event-received) for more details.",
    },
    action_ids: {
      type: "string[]",
      label: "Action IDs",
      description: "Filter interaction events by specific `action_id`'s to subscribe for new interaction events. If none are specified, all `action_ids` created via Pipedream will emit new events.",
      optional: true,
      default: [],
    },
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Filter interaction events by one or more channels. If none selected, any interaction event in any channel will emit new events.",
      optional: true,
      default: [],
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      /**
       * Subscribes to potentially 4 different events:
       * `interaction_events` - all interaction events on the authenticated account
       * `interaction_events:${action_id}` - all interaction events with a specific given action_id
       * `interaction_events:${channel_id}` - all interaction events within a specific channel
       * `interaction_events:${channel_id}:${action_id}` - action_id within a specific channel
       * @returns string[]
       */
      async eventNames() {
        // start with action_ids, since they can be the most specific
        const action_events = this.action_ids.reduce((carry, action_id) => {
          // if channels are provided, spread them
          if (this.conversations && this.conversations.length > 0) {
            return [
              ...carry,
              ...this.conversations.map(
                (channel) => `interaction_events:${channel}:${action_id}`,
              ),
            ];
          }

          return [
            ...carry,
            `interaction_events:${action_id}`,
          ];
        }, []);

        if (action_events.length > 0) return action_events;

        // if no action_ids are specified, move down to channels
        const channel_events = this.conversations.map(
          (channel) => `interaction_events:${channel}`,
        );

        if (channel_events.length > 0) return channel_events;

        // if not specific action_ids or channels are specified, subscribe to all events
        return [
          "interaction_events",
        ];
      },
    },
  },
  methods: {},
  async run(event) {
    this.$emit(
      {
        event,
      },
      {
        summary: `New interaction event${
          event?.channel?.id
            ? ` in channel ${event.channel.id}`
            : ""
        }${
          event.actions?.length > 0
            ? ` from action_ids ${event.actions
              .map((action) => action.action_id)
              .join(", ")}`
            : ""
        }`,
        ts: Date.now(),
      },
    );
  },
  sampleEmit,
};

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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Action IDs	`action_ids`	`string[]`	Filter interaction events by specific `action_id`'s to subscribe for new interaction events. If none are specified, all `action_ids` created via Pipedream will emit new events.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`

Trigger Authentication#

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

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

channels:historychannels:readchannels:writeemoji:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writereactions:readreactions:writereminders:readreminders:writestars:readteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:userfiles:write:usercommandsusers.profile:writeusers.profile:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

Action#

Rerun Workflow on CircleCI

Description:Reruns the specified workflow. [See the documentation](https://circleci.com/docs/api/v2/index.html#tag/Workflow/operation/rerunWorkflow)

Version:0.0.1

Key:circleci-rerun-workflow

View on GitHub

CircleCI Overview#

The CircleCI API allows for seamless integration and automation of your CI/CD pipeline. By leveraging the API through Pipedream, you can trigger builds, monitor the status of pipelines, fetch build artifacts, and interact with various aspects of your CircleCI projects. This facilitates the creation of dynamic workflows that can streamline development practices, enhance deployment strategies, and ensure continuous integration processes are more efficient and less error-prone.

Action Code#

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

export default {
  key: "circleci-rerun-workflow",
  name: "Rerun Workflow",
  description: "Reruns the specified workflow. [See the documentation](https://circleci.com/docs/api/v2/index.html#tag/Workflow/operation/rerunWorkflow)",
  version: "0.0.1",
  type: "action",
  props: {
    circleci,
    projectSlug: {
      propDefinition: [
        circleci,
        "projectSlug",
      ],
    },
    pipelineId: {
      propDefinition: [
        circleci,
        "pipelineId",
        (c) => ({
          projectSlug: c.projectSlug,
        }),
      ],
    },
    workflowId: {
      propDefinition: [
        circleci,
        "workflowId",
        (c) => ({
          pipelineId: c.pipelineId,
        }),
      ],
    },
    enableSsh: {
      type: "boolean",
      label: "Enable SSH",
      description: "Whether to enable SSH access for the triggering user on the newly-rerun job. Requires the jobs parameter to be used and so is mutually exclusive with the from_failed parameter.",
      optional: true,
    },
    fromFailed: {
      type: "boolean",
      label: "From Failed",
      description: "Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter.",
      optional: true,
    },
    jobIds: {
      propDefinition: [
        circleci,
        "jobIds",
        (c) => ({
          workflowId: c.workflowId,
        }),
      ],
    },
    sparseTree: {
      type: "boolean",
      label: "Sparse Tree",
      description: "",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.circleci.rerunWorkflow({
      $,
      workflowId: this.workflowId,
      data: {
        enable_ssh: this.enableSsh,
        from_failed: this.fromFailed,
        jobs: typeof this.jobIds === "string"
          ? JSON.parse(this.jobIds)
          : this.jobIds,
        sparse_tree: this.sparseTree,
      },
    });
    $.export("$summary", `Successfully started a rerun of workflow with ID: ${this.workflowId}`);
    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
CircleCI	`circleci`	`app`	This component uses the CircleCI app.
Project Slug	`projectSlug`	`string`	Project slug in the form `vcs-slug/org-name/repo-name` (found in Project Settings)
Pipeline ID	`pipelineId`	`string`	Select a value from the drop down menu.
Workflow ID	`workflowId`	`string`	Select a value from the drop down menu.
Enable SSH	`enableSsh`	`boolean`	Whether to enable SSH access for the triggering user on the newly-rerun job. Requires the jobs parameter to be used and so is mutually exclusive with the from_failed parameter.
From Failed	`fromFailed`	`boolean`	Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter.
Jobs	`jobIds`	`string[]`	Select a value from the drop down menu.
Sparse Tree	`sparseTree`	`boolean`

Rerun Workflow with CircleCI API on New Interaction Events (Instant) from Slack API

Pipedream makes it easy to connect APIs for CircleCI, Slack and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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