Create Campaign with Selzy API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm 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 npm 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 Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
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 Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

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

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      ts,
    });
  },
};

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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	One day interval time is recommended because NPM only update metrics once a day. See the documentation
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

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