Create Linked Pickup & Dropoff Tasks with Onfleet API on New Audit Event (Instant) from GitLab API

Pipedream makes it easy to connect APIs for Onfleet, GitLab and 2,700+ other apps remarkably fast.

Trigger workflow on

New Audit Event (Instant) from the GitLab API

Next, do this

Create Linked Pickup & Dropoff Tasks with the Onfleet 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 GitLab trigger and Onfleet 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 Path
Configure the Create Linked Pickup & Dropoff Tasks action
1. Connect your Onfleet account
2. Select a Merchant
3. Select a Executor
4. Configure Has A Pickup Recipient
5. Configure Has A Dropoff Recipient
6. Optional- Configure Destination Latitude
7. Optional- Configure Destination Longitude
8. Configure Address Line 1
9. Optional- Configure Address Line 2
10. Configure Address City
11. Configure Address State / Province
12. Configure Address Post Code / Zip
13. Configure Address Country
14. Select a Task Link Order
15. Select a Assignment
16. Optional- Configure Quantity
17. Optional- Configure Service Time
18. Configure Signature Requirement
19. Configure Photo Requirement
20. Configure Notes Requirement
21. Optional- Configure Minimum Age Requirement
22. Optional- Configure Complete After
23. Optional- Configure Complete Before
24. Optional- Configure Notes
25. Optional- Configure Appearance
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.3

Key:gitlab-new-audit-event

View on GitHub

GitLab Overview#

The GitLab API provides programmatic access to your GitLab projects, allowing you to automate common tasks, manage issues, merge requests, and more. With the GitLab API on Pipedream, you can create customized workflows that integrate with other services, streamline your development process, and enhance project management. By leveraging the power of serverless, you can set up triggers for GitLab events and perform actions across a variety of apps without managing infrastructure.

Trigger Code#

import gitlab from "../../gitlab.app.mjs";
import base from "../common/base.mjs";
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.3",
  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 this.gitlab._makeRequest({
          url: `https://${this._getBaseApiUrl()}/api/graphql`,
          method: "POST",
          headers: {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "Authorization": `Bearer ${this.gitlab.$auth.oauth_access_token}`,
          },
          data: query,
        });

      } 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 Path	`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#

GitLab is the most comprehensive AI-powered DevSecOps Platform.

Action#

Create Linked Pickup & Dropoff Tasks on Onfleet

Description:Create a pickup task and dropoff task linked with each other. [See the docs here](https://docs.onfleet.com/reference/create-task)

Version:0.0.1

Key:onfleet-create-pickup-dropoff-task

View on GitHub

Onfleet Overview#

The Onfleet API integrates with Pipedream to power logistics and delivery operations, offering real-time tracking, optimized routes, automatic dispatch, analytics, and communication with drivers. With Pipedream's serverless platform, one can automate complex workflows involving Onfleet and other apps, triggering actions based on events, scheduling tasks, or processing data to enhance delivery services.

Action Code#

import onfleet from "../../app/onfleet.app.mjs";
import { clearObj, prepareData } from "../common/utils.mjs";
export default {
    key: "onfleet-create-pickup-dropoff-task",
    name: "Create Linked Pickup & Dropoff Tasks",
    description: "Create a pickup task and dropoff task linked with each other. [See the docs here](https://docs.onfleet.com/reference/create-task)",
    type: "action",
    version: "0.0.1",
    props: {
        onfleet,
        merchant: {
            propDefinition: [
                onfleet,
                "merchant",
            ],
        },
        executor: {
            propDefinition: [
                onfleet,
                "merchant",
            ],
            label: "Executor",
            description: "The ID of the organization that will be responsible for fulfilling the task. Defaults to the creating organization. If you delegate your deliveries to a third party, provide their organization ID.",
        },
        hasPickupRecipient: {
            type: "boolean",
            label: "Has A Pickup Recipient",
            description: "If the pickup have a recipient who should be notified of task status changes.",
            reloadProps: true,
        },
        hasDropoffRecipient: {
            type: "boolean",
            label: "Has A Dropoff Recipient",
            description: "If the dropoff have a recipient who should be notified of task status changes.",
            reloadProps: true,
        },
        latitude: {
            propDefinition: [
                onfleet,
                "latitude",
            ],
            optional: true,
        },
        longitude: {
            propDefinition: [
                onfleet,
                "longitude",
            ],
            optional: true,
        },
        street: {
            propDefinition: [
                onfleet,
                "street",
            ],
        },
        apartment: {
            propDefinition: [
                onfleet,
                "apartment",
            ],
            optional: true,
        },
        city: {
            propDefinition: [
                onfleet,
                "city",
            ],
        },
        state: {
            propDefinition: [
                onfleet,
                "state",
            ],
        },
        postalCode: {
            propDefinition: [
                onfleet,
                "postalCode",
            ],
        },
        country: {
            propDefinition: [
                onfleet,
                "country",
            ],
        },
        taskLinkOrder: {
            type: "integer",
            label: "Task Link Order",
            description: "The order in which to create the linked task relationship. By default, the pickup is created as the prerequisite to the dropoff. Choose \"Dropoff first\" to reverse this order, requiring completion of the dropoff before the pickup.",
            default: 1,
            options: [
                {
                    label: "Pickup first",
                    value: 1,
                },
                {
                    label: "Dropoff first",
                    value: 2,
                },
            ],
        },
        autoAssign: {
            propDefinition: [
                onfleet,
                "autoAssign",
            ],
            reloadProps: true,
        },
        quantity: {
            propDefinition: [
                onfleet,
                "quantity",
            ],
            optional: true,
        },
        serviceTime: {
            propDefinition: [
                onfleet,
                "serviceTime",
            ],
            optional: true,
        },
        signatureRequirement: {
            propDefinition: [
                onfleet,
                "signatureRequirement",
            ],
        },
        photoRequirement: {
            propDefinition: [
                onfleet,
                "photoRequirement",
            ],
        },
        notesRequirement: {
            propDefinition: [
                onfleet,
                "notesRequirement",
            ],
        },
        minimumAgeRequirement: {
            propDefinition: [
                onfleet,
                "minimumAgeRequirement",
            ],
            optional: true,
        },
        completeAfter: {
            propDefinition: [
                onfleet,
                "completeAfter",
            ],
            optional: true,
        },
        completeBefore: {
            propDefinition: [
                onfleet,
                "completeBefore",
            ],
            optional: true,
        },
        notes: {
            propDefinition: [
                onfleet,
                "notes",
            ],
            optional: true,
        },
        appearance: {
            propDefinition: [
                onfleet,
                "appearance",
            ],
            optional: true,
        },
    },
    async additionalProps() {
        let props = {};
        if (this.hasPickupRecipient) {
            props = {
                ...props,
                pickupRecipientName: {
                    type: "string",
                    label: "Pickup Recipient Name",
                    description: "The person to be notified that the pickup is occurring.",
                },
                pickupRecipientPhone: {
                    type: "string",
                    label: "Pickup Recipient Phone",
                    description: "The phone of the pickup recipient.",
                },
                pickupRecipientNotes: {
                    type: "string",
                    label: "Pickup Recipient Notes",
                    description: "Notes related the recipient or the destination like door codes, beware of dog, etc.",
                    optional: true,
                },
            };
        }
        if (this.hasDropoffRecipient) {
            props = {
                ...props,
                dropoffRecipientName: {
                    type: "string",
                    label: "Dropoff Recipient Name",
                    description: "The person to be notified that the pickup is occurring.",
                },
                dropoffRecipientPhone: {
                    type: "string",
                    label: "Dropoff Recipient Phone",
                    description: "The phone of the dropoff recipient.",
                },
                dropoffRecipientNotes: {
                    type: "string",
                    label: "Dropoff Recipient Notes",
                    description: "Notes related the recipient or the destination like door codes, beware of dog, etc.",
                    optional: true,
                },
            };
        }
        if (this.autoAssign) {
            if (this.autoAssign != "auto-assign") {
                props = {
                    ...props,
                    team: {
                        type: "string",
                        label: "Team Id",
                        description: "The team's Id",
                        options: async () => {
                            const teams = await this.onfleet.listTeams();
                            return teams.map(({ id: value, name: label, }) => ({
                                label,
                                value,
                            }));
                        },
                    },
                };
            }
            if (this.autoAssign === "driver") {
                props = {
                    ...props,
                    worker: {
                        type: "string",
                        label: "Driver",
                        description: "The driver's Id",
                        options: async () => {
                            const drivers = await this.onfleet.listWorkers({
                                teamId: this.team,
                            });
                            return drivers.map(({ id: value, name: label, }) => ({
                                label,
                                value,
                            }));
                        },
                    },
                };
            }
        }
        return props;
    },
    methods: {
        async createTask(onfleet, data) {
            const preparedData = prepareData(data);
            return await onfleet.createTask(clearObj(preparedData));
        },
    },
    async run({ $ }) {
        const { onfleet, pickupRecipientName, pickupRecipientPhone, pickupRecipientNotes, dropoffRecipientName, dropoffRecipientPhone, dropoffRecipientNotes, taskLinkOrder, pickupLatitude, pickupLongitude, pickupAddress, dropoffLatitude, dropoffLongitude, dropoffAddress, recipientPickup, recipientDropoff, ...data } = this;
        const pickupObject = {
            ...data,
            recipientName: pickupRecipientName,
            recipientPhone: pickupRecipientPhone,
            recipientNotes: pickupRecipientNotes,
            recipient: recipientPickup,
            latitude: pickupLatitude,
            longitude: pickupLongitude,
            address: pickupAddress,
        };
        const dropoffObject = {
            ...data,
            recipientName: dropoffRecipientName,
            recipientPhone: dropoffRecipientPhone,
            recipientNotes: dropoffRecipientNotes,
            recipient: recipientDropoff,
            latitude: dropoffLatitude,
            longitude: dropoffLongitude,
            address: dropoffAddress,
        };
        let pickupResponse = {};
        let dropoffResponse = {};
        let response = {};
        let summary = "";
        if (taskLinkOrder == "1") {
            pickupResponse = await this.createTask(onfleet, {
                ...pickupObject,
            });
            dropoffResponse = await this.createTask(onfleet, {
                dependencies: [
                    pickupResponse.id,
                ],
                ...dropoffObject,
            });
            summary = `A new pickup task with id ${pickupResponse.id} was successfully created, then a new dropff task with id ${dropoffResponse.id} was successfully created!`;
        }
        else {
            dropoffResponse = await this.createTask(onfleet, {
                ...dropoffObject,
            });
            pickupResponse = await this.createTask(onfleet, {
                dependencies: [
                    dropoffResponse.id,
                ],
                ...pickupObject,
            });
            summary = `A new dropff task with id ${dropoffResponse.id} was successfully created, then a new pickup task with id ${pickupResponse.id} was successfully created!`;
        }
        response = {
            dropoffResponse,
            pickupResponse,
        };
        $.export("$summary", summary);
        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
Onfleet	`onfleet`	`app`	This component uses the Onfleet app.
Merchant	`merchant`	`string`	Select a value from the drop down menu.
Executor	`executor`	`string`	Select a value from the drop down menu.
Has A Pickup Recipient	`hasPickupRecipient`	`boolean`	If the pickup have a recipient who should be notified of task status changes.
Has A Dropoff Recipient	`hasDropoffRecipient`	`boolean`	If the dropoff have a recipient who should be notified of task status changes.
Destination Latitude	`latitude`	`string`	The Latitude of the destination.
Destination Longitude	`longitude`	`string`	The Longitude of the destination.
Address Line 1	`street`	`string`	If coordinates used, this will be for display purposes only. Coordinates will be relied on for actual location. Used for the number and name of the street.
Address Line 2	`apartment`	`string`	For display purposes only. Used for Apartment, suite or other descriptive information.
Address City	`city`	`string`	If coordinates used, for display purposes only. Coordinates will be relied on for actual location.
Address State / Province	`state`	`string`	If coordinates used, for display purposes only. Coordinates will be relied on for actual location.
Address Post Code / Zip	`postalCode`	`string`	If coordinates used, for display purposes only. Coordinates will be relied on for actual location.
Address Country	`country`	`string`	If coordinates used, for display purposes only. Coordinates will be relied on for actual location.
Task Link Order	`taskLinkOrder`	`integer`	Select a value from the drop down menu:`{ "label": "Pickup first", "value": 1 }{ "label": "Dropoff first", "value": 2 }`
Assignment	`autoAssign`	`string`	Select a value from the drop down menu:`auto-assignteamdriver`
Quantity	`quantity`	`integer`	The number of units to be dropped off while completing this task, for route optimization purposes.
Service Time	`serviceTime`	`integer`	The number of minutes to be spent by the worker on arrival at this task's destination, for route optimization purposes.
Signature Requirement	`signatureRequirement`	`boolean`	A signature must be collected to complete this task.
Photo Requirement	`photoRequirement`	`boolean`	A photo must be collected to complete this task.
Notes Requirement	`notesRequirement`	`boolean`	Task completion notes must be submitted to complete this task.
Minimum Age Requirement	`minimumAgeRequirement`	`integer`	The recipient's ID must be scanned and their age verified to be greater than or equal to the `minimumAge` in order to complete the task. Must be in a plan that supports ID verification.
Complete After	`completeAfter`	`integer`	A timestamp in unix time for the earliest time the task should be completed, in milliseconds precision.
Complete Before	`completeBefore`	`integer`	A timestamp in unix time for the latest time the task should be completed, in milliseconds precision.
Notes	`notes`	`string`	Notes for the task. Field length cannot exceed 10,000 characters.
Appearance	`appearance`	`object`	Set triangle colored pins on the map.

Action Authentication#

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

To retrieve your API key,

Navigate to your Onfleet account and sign in
Go to Settings > API & Webhooks

Create Linked Pickup & Dropoff Tasks with Onfleet API on New Audit Event (Instant) from GitLab API

Pipedream makes it easy to connect APIs for Onfleet, GitLab and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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