Create Campaign with Selzy API on New Task Arrival (Instant) from Onfleet API

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

Trigger workflow on

New Task Arrival (Instant) from the Onfleet API

Next, do this

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

Select this integration
Configure the New Task Arrival (Instant) trigger
1. Connect your Onfleet account
2. Configure Name
Configure the Create Campaign action
1. Connect your Selzy account
2. Optional- Configure Message ID
3. Optional- Configure Start Time
4. Optional- Configure Track Read
5. Optional- Configure Track Links
6. Optional- Configure Contacts URL
7. Optional- Configure Track GA
8. Optional- Configure GA Medium
9. Optional- Configure GA Source
10. Optional- Configure GA Campaign
11. Optional- Configure GA Content
12. Optional- Configure GA Term
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 Task Arrival (Instant) on Onfleet

Description:Emit new event when a new task is arrival.

Version:0.0.1

Key:onfleet-new-task-arrival

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.

Trigger Code#

import moment from "moment";
import base from "../common/base.mjs";
export default {
    ...base,
    key: "onfleet-new-task-arrival",
    name: "New Task Arrival (Instant)",
    description: "Emit new event when a new task is arrival.",
    version: "0.0.1",
    dedupe: "unique",
    type: "source",
    methods: {
        ...base.methods,
        getTrigger() {
            return 2;
        },
        generateMeta({ id, taskId, time, timeCreated, }) {
            return {
                id: `${taskId || id}${time || timeCreated}`,
                summary: `New Task arrival: ${taskId || id}`,
                ts: moment(time || timeCreated).format(),
            };
        },
        async startDeploy() {
            //It doesn't have pagination and sorting.
            return;
        },
    },
};

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
Onfleet	`onfleet`	`app`	This component uses the Onfleet app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Name	`webhookName`	`string`	A name for the webhook for identification.

Trigger 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

About Onfleet#

Onfleet is the world's most advanced last mile delivery platform.

Action#

Create Campaign on Selzy

Description:Creates a new campaign. [See the documentation](https://selzy.com/en/support/api/messages/createcampaign/)

Version:0.0.1

Key:selzy-create-campaign

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { clearEmpty } from "../../common/utils.mjs";
import selzy from "../../selzy.app.mjs";

export default {
  key: "selzy-create-campaign",
  name: "Create Campaign",
  description: "Creates a new campaign. [See the documentation](https://selzy.com/en/support/api/messages/createcampaign/)",
  version: "0.0.1",
  type: "action",
  props: {
    selzy,
    messageId: {
      type: "string",
      label: "Message ID",
      description: "Code of the message to be sent. The code returned by the **Create Email Message** method should be transferred.",
      optional: true,
    },
    startTime: {
      type: "string",
      label: "Start Time",
      description: "Campaign launch date and time in the \"YYYY-MM-DD hh:mm\" format, which do not exceed 100 days from the current date. If the argument is not set, the campaign starts immediately. The time zone specified in the settings of the user's personal account is applied. To explicitly specify a time zone, use the **Timezone** argument. To provide additional error protection, you should not schedule two sendings of the same message within an hour.",
      optional: true,
    },
    trackRead: {
      type: "boolean",
      label: "Track Read",
      description: "Whether to track the fact of reading the email message. The default value is `false` (do not track). If `true`, a link to a small image tracking the reference will be added to the email. The **Track Read** argument is ignored for SMS messages.",
      optional: true,
    },
    trackLinks: {
      type: "boolean",
      label: "Track Links",
      description: "To track whether there are any click-throughs in email messages, the default value is `false` (do not track). If `true`, all external links will be replaced with special ones that allow you to track the fact of a click-through, and then forward the user to the desired page. The **Track Links** argument is ignored for SMS messages.",
      optional: true,
    },
    contactsUrl: {
      type: "string",
      label: "Contacts URL",
      description: "Instead of the contacts parameter containing the actual email addresses or phone numbers, in this parameter you can specify the URL of the file from which the addresses (phone numbers) will be read. The URL must start with \"http://\", \"https://\" or \"ftp://\". The file must contain one contact per string, without commas; strings must be separated by \"n\" or \"rn\" (Mac format — only \"r\" — not supported). The file can be deleted after the campaign has shifted to the 'scheduled' status.",
      optional: true,
    },
    trackGa: {
      type: "boolean",
      label: "Track GA",
      description: "Whether to enable Google Analytics integration for this campaign. Only explicitly indicated values are valid, default usage parameters are not applied. The default value is `false` (disabled).",
      optional: true,
      reloadProps: true,
    },
    gaMedium: {
      type: "string",
      label: "GA Medium",
      description: "Integration parameters with Google Analytics (valid if track_ga=1). Only explicitly indicated values are valid, default usage parameters are not applied.",
      optional: true,
      hidden: true,
    },
    gaSource: {
      type: "string",
      label: "GA Source",
      description: "Integration parameters with Google Analytics (valid if track_ga=1). Only explicitly indicated values are valid, default usage parameters are not applied.",
      optional: true,
      hidden: true,
    },
    gaCampaign: {
      type: "string",
      label: "GA Campaign",
      description: "Integration parameters with Google Analytics (valid if track_ga=1). Only explicitly indicated values are valid, default usage parameters are not applied.",
      optional: true,
      hidden: true,
    },
    gaContent: {
      type: "string",
      label: "GA Content",
      description: "Integration parameters with Google Analytics (valid if track_ga=1). Only explicitly indicated values are valid, default usage parameters are not applied.",
      optional: true,
      hidden: true,
    },
    gaTerm: {
      type: "string",
      label: "GA Term",
      description: "Integration parameters with Google Analytics (valid if track_ga=1). Only explicitly indicated values are valid, default usage parameters are not applied.",
      optional: true,
      hidden: true,
    },
  },
  async additionalProps(props) {
    const gaAllowed = this.trackGa;
    props.gaMedium.hidden = !gaAllowed;
    props.gaSource.hidden = !gaAllowed;
    props.gaCampaign.hidden = !gaAllowed;
    props.gaContent.hidden = !gaAllowed;
    props.gaTerm.hidden = !gaAllowed;

    return {};
  },
  async run({ $ }) {
    if (this.contacts && this.contactsUrl) {
      throw new ConfigurationError("You can't set both contacts and contactsUrl parameters at the same time");
    }

    const response = await this.selzy.createCampaign({
      $,
      params: clearEmpty({
        message_id: this.messageId,
        start_time: this.startTime,
        track_read: this.trackRead
          ? 1
          : 0,
        track_links: this.trackLinks
          ? 1
          : 0,
        contacts_url: this.contactsUrl,
        track_ga: this.trackGa && +this.trackGa,
        ga_medium: this.gaMedium,
        ga_source: this.gaSource,
        ga_campaign: this.gaCampaign,
        ga_content: this.gaContent,
        ga_term: this.gaTerm,
      }),
    });

    if (response.error) throw new ConfigurationError(response.error);

    $.export("$summary", `Successfully created email campaign with ID: ${response.result.campaign_id}`);
    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
Selzy	`selzy`	`app`	This component uses the Selzy app.
Message ID	`messageId`	`string`	Code of the message to be sent. The code returned by the Create Email Message method should be transferred.
Start Time	`startTime`	`string`	Campaign launch date and time in the "YYYY-MM-DD hh:mm" format, which do not exceed 100 days from the current date. If the argument is not set, the campaign starts immediately. The time zone specified in the settings of the user's personal account is applied. To explicitly specify a time zone, use the Timezone argument. To provide additional error protection, you should not schedule two sendings of the same message within an hour.
Track Read	`trackRead`	`boolean`	Whether to track the fact of reading the email message. The default value is `false` (do not track). If `true`, a link to a small image tracking the reference will be added to the email. The Track Read argument is ignored for SMS messages.
Track Links	`trackLinks`	`boolean`	To track whether there are any click-throughs in email messages, the default value is `false` (do not track). If `true`, all external links will be replaced with special ones that allow you to track the fact of a click-through, and then forward the user to the desired page. The Track Links argument is ignored for SMS messages.
Contacts URL	`contactsUrl`	`string`	Instead of the contacts parameter containing the actual email addresses or phone numbers, in this parameter you can specify the URL of the file from which the addresses (phone numbers) will be read. The URL must start with "http://", "https://" or "ftp://". The file must contain one contact per string, without commas; strings must be separated by "n" or "rn" (Mac format — only "r" — not supported). The file can be deleted after the campaign has shifted to the 'scheduled' status.
Track GA	`trackGa`	`boolean`	Whether to enable Google Analytics integration for this campaign. Only explicitly indicated values are valid, default usage parameters are not applied. The default value is `false` (disabled).

Create Campaign with Selzy API on New Task Arrival (Instant) from Onfleet API

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

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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