Run Python Code with Python API on New Audit Event (Instant) from Gitlab API

Pipedream makes it easy to connect APIs for Python, Gitlab and 1,600+ other apps remarkably fast.

Trigger workflow on

New Audit Event (Instant) from the Gitlab API

Next, do this

Run Python Code with the Python API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Audit Event (Instant) trigger
1. Connect your Gitlab account
2. Select a Group ID
Configure the Run Python Code action
1. Connect your Python account
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 Audit Event (Instant) on Gitlab

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

Version:0.1.2

Key:gitlab-new-audit-event

View on GitHub

Gitlab Overview#

Gitlab API allows developers to access the functionality of Gitlab. With the
Gitlab API, developers can integrate Gitlab with other applications, create
custom applications, or automate tasks.

Some examples of what you can build using the Gitlab API include:

Automate tasks such as creating and managing repositories
Integrate Gitlab with other applications such as your chat application
Create custom applications on top of Gitlab

Trigger 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.2",
  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://${this._getBaseApiUrl()}/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://${this._getBaseApiUrl()}/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://${this._getBaseApiUrl()}/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;
    },
  },
};

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

Trigger 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

About Gitlab#

Project planning and source code management

Action#

Run Python Code on Python

Description:Write Python and use any of the 350k+ PyPi packages available. Refer to the [Pipedream Python docs](https://pipedream.com/docs/code/python) to learn more.

Version:0.0.2

Key:python-run-python-code

View on GitHub

Python Overview#

Python API on Pipedream offers developers to build or automate a variety of
tasks from their web and cloud apps. With the Python API, users are able to
create comprehensive and flexible scripts, compose and manage environment
variables, and configure resources to perform a range of functions.

By using Pipedream, you can easily:

Create automated workflows that run on a specific schedule
Compose workflows across various apps and services
React to events in cloud services or form data
Automatically create content and notifications
Construct classifications and predictions
Analyze and react to sentiment, sentiment analysis and sentiment score
Connect backends to the frontend with serverless functions
Work with files and databases
Perform web requests and fetch data
Integrate third-party APIs into your apps
Orchestrate data processing tasks and pipelines
Create powerful application APIs with authentication and authorization
Design CI/CD pipelines and Continuous Delivery services
Connect databases like MongoDB and MySQL
Monitor connections and events
Generate alerts and notifications for corresponding events

Action Code#

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

export default {
  name: "Run Python Code",
  version: "0.0.2",
  key: "python-run-python-code",
  description: "Write Python and use any of the 350k+ PyPi packages available. Refer to the [Pipedream Python docs](https://pipedream.com/docs/code/python) to learn more.",
  props: {
    python,
  },
  type: "action",
  methods: {},
  async run({
    steps, $,
  }) {
    // Placeholder action for Python code app
  },
};

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
Python	`python`	`app`	This component uses the Python app.

Run Python Code with Python API on New Audit Event (Instant) from Gitlab API

Pipedream makes it easy to connect APIs for Python, Gitlab and 1,600+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-12of1,600+apps by most popular

1
-
12
of
1,600+
apps by most popular