Add Subscriber with Mailwizz API on New Commit Comment from GitHub API

Pipedream makes it easy to connect APIs for Mailwizz, GitHub and 2,400+ other apps remarkably fast.

Trigger workflow on

New Commit Comment from the GitHub API

Next, do this

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

Select this integration
Configure the New Commit Comment trigger
1. Configure eventTypeInfo
2. Connect your GitHub account
3. Select a Repository
Configure the Add Subscriber action
1. Connect your Mailwizz account
2. Select a List UID
3. Configure Email
4. Optional- Configure First Name
5. Optional- Configure Last Name
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 Commit Comment on GitHub

Description:Emit new event when a commit comment is created

Version:1.0.7

Key:github-new-commit-comment

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-commit-comment",
  name: "New Commit Comment",
  description: "Emit new event when a commit comment is created",
  version: "1.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    eventTypeInfo: {
      type: "alert",
      alertType: "info",
      content: "**Note:** commit comments are not the same as pull request comments. [See the GitHub documentation](https://docs.github.com/en/rest/guides/working-with-comments?apiVersion=2022-11-28) for more information.",
    },
    ...common.props,
  },
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "commit_comment",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.action === "created";
    },
    getWebhookEventItem(body) {
      return body.comment;
    },
    getSummary(item) {
      return `New comment (${item.id})`;
    },
    getPollingData(args) {
      return this.github.getRepositoryLatestCommitComments(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#commit_comment";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/commits/comments?apiVersion=2022-11-28#list-commit-comments-for-a-repository";
    },
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

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

repoadmin:orgadmin:public_keyadmin:org_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action#

Add Subscriber on Mailwizz

Description:Create a new subscriber to a list. [See the docs here](https://api-docs.mailwizz.com/?python#create-a-subscriber)

Version:0.0.1

Key:mailwizz-add-subscriber

View on GitHub

Mailwizz Overview#

Mailwizz offers a potent API that enables automation of email marketing tasks, subscriber management, campaign tracking, and more. Using Pipedream, you can harness this API to create custom workflows that trigger on specific events, process data, or synchronize with other apps. Pipedream's serverless architecture allows you to handle workflows at scale without managing infrastructure.

Action Code#

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

export default {
  key: "mailwizz-add-subscriber",
  name: "Add Subscriber",
  version: "0.0.1",
  description: "Create a new subscriber to a list. [See the docs here](https://api-docs.mailwizz.com/?python#create-a-subscriber)",
  type: "action",
  props: {
    mailwizz,
    listId: {
      propDefinition: [
        mailwizz,
        "listId",
      ],
      description: "The list uid to which this customer will be added.",
    },
    email: {
      propDefinition: [
        mailwizz,
        "email",
      ],
    },
    fname: {
      propDefinition: [
        mailwizz,
        "fname",
      ],
      optional: true,
    },
    lname: {
      propDefinition: [
        mailwizz,
        "lname",
      ],
      optional: true,
    },
  },
  async run ( { $ } ) {
    const {
      mailwizz,
      listId,
      email,
      fname,
      lname,
    } = this;

    const response = await mailwizz.createSubscriber( {
      listId,
      data: {
        EMAIL: email,
        FNAME: fname,
        LNAME: lname,
      },
    } );

    $.export( "$summary", `Subscriber with id ${response.data.record.subscriber_uid} was successfully created!` );
    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
Mailwizz	`mailwizz`	`app`	This component uses the Mailwizz app.
List UID	`listId`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	The subscriber's email.
First Name	`fname`	`string`	The subscriber's first name.
Last Name	`lname`	`string`	The subscriber's last name.

Action Authentication#

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

To retrieve your API Key,

Navigate to your Mailwizz account and sign in
Click the option with the Star icon in the left navigation menu
Go to “API Keys”

The URL field below is your Mailwizz host domain.

For example, if you have a Mailwizz instance hosted at https://example.com, then enter example.com in the url field below.

Please note that if the MailWizz hosted website doesn't have clean urls enabled, make sure your url has the index.php part of url included, i.e:
example.com/api/index.php

Add Subscriber with Mailwizz API on New Commit Comment from GitHub API

Pipedream makes it easy to connect APIs for Mailwizz, GitHub and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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