New Audit Event (Instant) from Gitlab API

Pipedream makes it easy to connect APIs for Gitlab and 1200+ other apps remarkably fast.

Trigger workflow on

New Audit Event (Instant) from the Gitlab API

Next, do this

Connect to 1200+ APIs using code and no-code building blocks

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

Trigger a workflow on New Audit Event (Instant) with Gitlab API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the New Audit Event (Instant) trigger
1. Connect your Gitlab account
2. Select a Group ID
Add steps to connect to 1200+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Send Message with Discord Webhook API on New Audit Event (Instant) from Gitlab API

Gitlab + Discord Webhook

Try it

Add Multiple Rows with Google Sheets API on New Audit Event (Instant) from Gitlab API

Gitlab + Google Sheets

Try it

Get Film with SWAPI - Star Wars API on New Audit Event (Instant) from Gitlab API

Gitlab + SWAPI - Star Wars

Try it

Create Multiple Records with Airtable API on New Audit Event (Instant) from Gitlab API

Gitlab + Airtable

Try it

Chat with OpenAI (ChatGPT) API on New Audit Event (Instant) from Gitlab API

Gitlab + OpenAI (ChatGPT)

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.

New Audit Event (Instant) on Gitlab

Description:Emit new event when a new audit event is created

Version:0.1.1

Key:gitlab-new-audit-event

View on GitHub

Code#

import gitlab from "../../gitlab.app.mjs";
import base from "../common/base.mjs";
import fetch from "node-fetch";
import {
  create_destination,
  list_destinations,
  delete_destination,
} from "./common-queries.mjs";

export default {
  ...base,
  key: "gitlab-new-audit-event",
  name: "New Audit Event (Instant)",
  description: "Emit new event when a new audit event is created",
  version: "0.1.1",
  dedupe: "unique",
  type: "source",
  props: {
    gitlab,
    http: {
      // doesn't include base because base has a project, which we don't need
      type: "$.interface.http",
      customResponse: true,
    },
    groupPath: {
      propDefinition: [
        gitlab,
        "groupPath",
      ],
    },
  },
  hooks: {
    ...base.hooks,
    async activate() {
      console.log("Activating streaming audit events.");
      console.log(`Event destination: ${this.http.endpoint}`);
      console.log(`Group name: ${this.groupPath}`);

      // the variable must be named "query" to work with JSON.stringify and GraphQL
      const query = create_destination(this.http.endpoint, this.groupPath);

      try {
        await fetch("https://gitlab.com/api/graphql", {
          method: "POST",
          headers: {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "Authorization": `Bearer ${this.gitlab.$auth.oauth_access_token}`,
          },
          body: JSON.stringify({
            query,
          }),
        })
          .then((r) => r.json());

      } catch (err) {
        console.log(`Error thrown during activation: ${JSON.stringify(err)}`);
      }
    },
    async deactivate() {
      console.log("Deactivating streaming audit events.");
      console.log(`Event destiniation: ${this.http.endpoint}`);
      console.log(`Group name: ${this.groupPath}`);

      // the variable must be named "query" to work with JSON.stringify and GraphQL
      var query = list_destinations(this.groupPath);

      try {

        const data = await fetch("https://gitlab.com/api/graphql", {
          method: "POST",
          headers: {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "Authorization": `Bearer ${this.gitlab.$auth.oauth_access_token}`,
          },
          body: JSON.stringify({
            query,
          }),
        })
          .then((r) => r.json());
        console.log("Group list received.");
        console.log(`Received: ${JSON.stringify(data)}`);

        const todelete = data.data.group.externalAuditEventDestinations
          .nodes.filter((item) => item.destinationUrl == this.http.endpoint)[0].id;
        console.log(`Deleting object ID: ${JSON.stringify(todelete)}`);

        query = delete_destination(todelete);

        await fetch("https://gitlab.com/api/graphql", {
          method: "POST",
          headers: {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "Authorization": `Bearer ${this.gitlab.$auth.oauth_access_token}`,
          },
          body: JSON.stringify({
            query,
          }),
        })
          .then((r) => r.json());

        console.log("Done deactivating!");

      } catch (err) {
        console.log(`Error thrown during deactivation: ${JSON.stringify(err)}`);
      }
    },
  },
  methods: {
    ...base.methods,
    generateMeta(event) {
      const id = event.id;
      return {
        id,
        summary: `New Audit Event: ${id}`,
        ts: +new Date(),
      };
    },
    emitEvent(event) {
      const meta = this.generateMeta(event);
      this.$emit(event, meta);
    },
    isValidSource() {
      // GitLab doesn't currently send a x-gitlab-token
      // with streaming audit events
      return true;
    },
    isValidEvent() {
      return true;
    },
  },
};

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
Gitlab	`gitlab`	`app`	This component uses the Gitlab 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.
Group ID	`groupPath`	`string`	Select a value from the drop down menu.

Authentication#

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

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

apiread_userread_repositorywrite_repositoryread_registrysudoopenidprofileemail