Churn Subscription with ProfitWell API on New Webhook Event (Instant) from GitHub API

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

Trigger workflow on

New Webhook Event (Instant) from the GitHub API

Next, do this

Churn Subscription with the ProfitWell 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 ProfitWell action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Webhook Event (Instant) trigger
1. Configure docsInfo
2. Connect your GitHub account
3. Select a Repository
4. Select one or more Webhook Events
Configure the Churn Subscription action
1. Connect your ProfitWell account
2. Configure Subscription ID or Alias
3. Configure Effective Date
4. Select a Churn Type
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 Webhook Event (Instant) on GitHub

Description:Emit new event for each selected event type

Version:1.0.7

Key:github-webhook-events

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-webhook.mjs";
import constants from "../common/constants.mjs";
import { getRelevantHeaders } from "../common/utils.mjs";

export default {
  ...common,
  key: "github-webhook-events",
  name: "New Webhook Event (Instant)",
  description: "Emit new event for each selected event type",
  type: "source",
  version: "1.0.7",
  dedupe: "unique",
  props: {
    docsInfo: {
      type: "alert",
      alertType: "info",
      content: "[See the GitHub documentation](https://docs.github.com/en/webhooks/webhook-events-and-payloads) for more information on available events.",
    },
    ...common.props,
    events: {
      label: "Webhook Events",
      description: "The event types to be emitted",
      type: "string[]",
      options: constants.REPOSITORY_WEBHOOK_EVENTS,
      reloadProps: true,
    },
  },
  async additionalProps() {
    await this.requireAdminPermission();
    const props = {};
    if (this.events?.length && this.events.includes("pull_request_review")) {
      props.reviewState = {
        type: "string",
        label: "Review State",
        description: "Filter `pull_request_review` events by review state",
        options: constants.PULL_REQUEST_REVIEW_STATES,
        optional: true,
      };
    }
    return props;
  },
  methods: {
    ...common.methods,
    getWebhookEvents() {
      return this.events;
    },
  },
  async run(event) {
    const {
      headers,
      body,
    } = event;

    // skip initial response from Github
    if (body?.zen) {
      console.log(body.zen);
      return;
    }

    if (headers["x-github-event"] === "pull_request_review" && this.reviewState && body.review.state !== this.reviewState) {
      return;
    }

    this.$emit({
      ...getRelevantHeaders(headers),
      ...body,
    }, {
      id: headers["x-github-delivery"],
      summary: `New event ${headers["x-github-hook-installation-target-id"]} of type ${headers["x-github-hook-installation-target-type"]}`,
      ts: new Date(),
    });
  },
  async activate() {
    const isAdmin = await this.checkAdminPermission();
    if (!isAdmin) {
      throw new Error("Webhooks are only supported on repos where you have admin access.");
    }
    await this.createWebhook();
  },
};

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.
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.
Webhook Events	`events`	`string[]`	Select a value from the drop down menu:`{ "label": "Activity related to a branch protection rule", "value": "branch_protection_rule" }{ "label": "Check run activity has occurred", "value": "check_run" }{ "label": "Check suite activity has occurred", "value": "check_suite" }{ "label": "Activity related to code scanning alerts in a repository", "value": "code_scanning_alert" }{ "label": "A commit comment is created", "value": "commit_comment" }{ "label": "A Git branch or tag is created", "value": "create" }{ "label": "A Git branch or tag is deleted", "value": "delete" }{ "label": "A deploy key is added or removed from a repository", "value": "deploy_key" }{ "label": "A deployment is created", "value": "deployment_status" }{ "label": "Activity related to a discussion", "value": "discussion" }{ "label": "Activity related to a comment in a discussion", "value": "discussion_comment" }{ "label": "A user forks a repository", "value": "fork" }{ "label": "A wiki page is created or updated", "value": "gollum" }{ "label": "Activity related to an issue or pull request comment", "value": "issue_comment" }{ "label": "Activity related to an issue", "value": "issues" }{ "label": "Activity related to a label", "value": "label" }{ "label": "Activity related to repository collaborators", "value": "member" }{ "label": "The webhook this event is configured on was deleted", "value": "meta" }{ "label": "Activity related to milestones", "value": "milestone" }{ "label": "Activity related to GitHub Packages", "value": "package" }{ "label": "Activity on attempted build of a GitHub Pages site, whether successful or not", "value": "page_build" }{ "label": "Activity related to project boards", "value": "project" }{ "label": "Activity related to project cards", "value": "project_card" }{ "label": "Activity related to columns in a project board", "value": "project_column" }{ "label": "When a private repository is made public", "value": "public" }{ "label": "Activity related to pull requests", "value": "pull_request" }{ "label": "Activity related to pull request reviews", "value": "pull_request_review" }{ "label": "Activity related to pull request review comments in the pull request's unified diff", "value": "pull_request_review_comment" }{ "label": "Activity related to a comment thread on a pull request being marked as resolved or unresolved", "value": "pull_request_review_thread" }{ "label": "One or more commits are pushed to a repository branch or tag", "value": "push" }{ "label": "Activity related to a release", "value": "release" }{ "label": "Activity related to a repository", "value": "repository" }{ "label": "Activity related to a repository being imported to GitHub", "value": "repository_import" }{ "label": "Activity related to security vulnerability alerts in a repository", "value": "repository_vulnerability_alert" }{ "label": "Activity related to a repository being starred", "value": "star" }{ "label": "When the status of a Git commit changes", "value": "status" }{ "label": "When a repository is added to a team", "value": "team_add" }{ "label": "When someone stars a repository", "value": "watch" }{ "label": "A GitHub Actions workflow job has been queued, is in progress, or has been completed on a repository", "value": "workflow_job" }{ "label": "When a GitHub Actions workflow run is requested or completed", "value": "workflow_run" }`

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#

Churn Subscription on ProfitWell

Description:Churn a subscription [See docs here](https://profitwellapiv2.docs.apiary.io/#/reference/manually-added-customers/updating-subscriptions/churn-a-subscription)

Version:0.0.1

Key:profitwell-churn-subscription

View on GitHub

ProfitWell Overview#

The ProfitWell API provides programmatic access to metrics and data related to subscription-based businesses. By integrating with Pipedream, you can automate complex workflows involving your financial metrics, customer insights, and growth tracking. Whether it's syncing subscriber data with marketing platforms, triggering alerts based on revenue milestones, or creating custom analytics dashboards, Pipedream's serverless platform enables you to connect ProfitWell with a plethora of other services without writing extensive code.

Action Code#

import profitwell from "../../app/profitwell.app.mjs";
import { defineAction } from "@pipedream/types";
import { EffectiveDateDescription } from "../../common/propDescriptions.mjs";
export default defineAction({
    name: "Churn Subscription",
    description: "Churn a subscription [See docs here](https://profitwellapiv2.docs.apiary.io/#/reference/manually-added-customers/updating-subscriptions/churn-a-subscription)",
    key: "profitwell-churn-subscription",
    version: "0.0.1",
    type: "action",
    props: {
        profitwell,
        subscriptionIdOrAlias: {
            propDefinition: [
                profitwell,
                "subscriptionIdOrAlias",
            ],
        },
        effectiveDate: {
            propDefinition: [
                profitwell,
                "effectiveDate",
            ],
            description: EffectiveDateDescription("the subscription churns"),
        },
        churnType: {
            type: "string",
            label: "Churn Type",
            options: [
                "voluntary",
                "delinquent",
            ],
            default: "voluntary",
        },
    },
    async run({ $ }) {
        const params = {
            $,
            subscriptionIdOrAlias: this.subscriptionIdOrAlias,
            params: {
                churn_type: this.churnType,
                effective_date: this.profitwell.getUnixTimestamp(this.effectiveDate),
            },
        };
        const data = await this.profitwell.churnSubscription(params);
        const label = this.profitwell.getSubscriptionLabel(data);
        $.export("$summary", `Successfully churned subscription ${label}`);
        return data;
    },
});

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
ProfitWell	`profitwell`	`app`	This component uses the ProfitWell app.
Subscription ID or Alias	`subscriptionIdOrAlias`	`string`	Either the `subscription_id` or `subscription_alias` of the subscription
Effective Date	`effectiveDate`	`string`	UNIX timestamp (in seconds) of when the subscription churns. You can also provide a valid date/time string and Pipedream will automatically convert it to a UNIX timestamp. Examples: `1644933600` `2022-02-15` `2022-02-15T14:00Z`
Churn Type	`churnType`	`string`	Select a value from the drop down menu:`voluntarydelinquent`

Action Authentication#

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

To retrieve your API token,

Navigate to your ProfitWell account and sign in
Go to Account Settings > Integrations > ProfitWell API

Churn Subscription with ProfitWell API on New Webhook Event (Instant) from GitHub API

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

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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