Delete a Subscription with Pipedream API on New User Created from Vitally API

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

Trigger workflow on

New User Created from the Vitally API

Next, do this

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

Select this integration
Configure the New User Created trigger
1. Connect your Vitally account
2. Configure Polling interval
3. Optional- Select a Account Id
4. Optional- Select a Organization Id
Configure the Delete a Subscription action
1. Connect your Pipedream account
2. Select a Subscription category
3. Select a Subscription source
4. Optional- Select a Event name
5. Configure Listener ID
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 User Created on Vitally

Description:Emit new event when a new user is created.

Version:0.0.2

Key:vitally-new-user-created

View on GitHub

Vitally Overview#

The Vitally API offers a window into customer success operations, enabling you to automate workflows, integrate with other tools, and manipulate customer data programmatically. With Pipedream, you can harness this API to create custom automations that react to events in Vitally, sync data between Vitally and other platforms, or maintain up-to-date customer profiles across your business stack.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import moment from "moment";
import vitally from "../../vitally.app.mjs";

export default {
  key: "vitally-new-user-created",
  name: "New User Created",
  version: "0.0.2",
  description: "Emit new event when a new user is created.",
  type: "source",
  dedupe: "unique",
  props: {
    vitally,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Vitally on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    accountId: {
      propDefinition: [
        vitally,
        "accountId",
      ],
      optional: true,
    },
    organizationId: {
      propDefinition: [
        vitally,
        "organizationId",
      ],
      optional: true,
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || 0;
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent(maxResults) {
      const {
        vitally,
        accountId,
        organizationId,
      } = this;

      let responseArray = [];
      const lastDate = this._getLastDate();
      const items = vitally.paginate({
        fn: vitally.listUsers,
        accountId,
        organizationId,
        maxResults,
        params: {
          sortBy: "createdAt",
        },
      });

      for await (const item of items) {
        if (moment(item.createdAt).isSameOrBefore(lastDate)) {
          break;
        }
        responseArray.push(item);
      }

      if (responseArray.length) {
        this._setLastDate(responseArray[0].createdAt);
      }

      for (const responseItem of responseArray.reverse()) {
        this.$emit(
          responseItem,
          {
            id: responseItem.id,
            summary: `A new user with id: "${responseItem.id}" was created!`,
            ts: responseItem.createdAt,
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
};

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
Vitally	`vitally`	`app`	This component uses the Vitally app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Vitally on this schedule
Account Id	`accountId`	`string`	Select a value from the drop down menu.
Organization Id	`organizationId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To retrieve your API Key,

Click the drop down on the top left with Vitally logo
Go to “Settings” > “Integrations” > Vitally REST API
Copy the API Key under Secret Token

About Vitally#

Modern #CustomerSuccess for B2B SaaS. 🚀 Unify your data, understand it deeply, and build powerful automation to drive a world-class customer experience.

Action#

Delete a Subscription on Pipedream

Description:Delete a Subscription. [See Doc](https://pipedream.com/docs/api/rest/#delete-a-subscription)

Version:0.1.0

Key:pipedream-delete-subscription

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Action Code#

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

export default {
  key: "pipedream-delete-subscription",
  name: "Delete a Subscription",
  description: "Delete a Subscription. [See Doc](https://pipedream.com/docs/api/rest/#delete-a-subscription)",
  version: "0.1.0",
  type: "action",
  props: {
    pipedream,
    subscriptionCategory: {
      propDefinition: [
        pipedream,
        "subscriptionCategory",
      ],
    },
    subscriptionSource: {
      propDefinition: [
        pipedream,
        "subscriptionSource",
        (c) => ({
          subscriptionCategory: c.subscriptionCategory,
        }),
      ],
    },
    eventName: {
      propDefinition: [
        pipedream,
        "eventName",
      ],
    },
    listenerId: {
      propDefinition: [
        pipedream,
        "listenerId",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.pipedream
      .deleteSubscription(this.subscriptionSource, this.listenerId, this.eventName);
    response?.data?.length > 0 && $.export("$summary", "Successfully deleted Subscription");
    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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Subscription category	`subscriptionCategory`	`string`	Select a value from the drop down menu:`OrganisationUserGlob patterns`
Subscription source	`subscriptionSource`	`string`	Select a value from the drop down menu.
Event name	`eventName`	`string`	Select a value from the drop down menu:`$errors$logs`
Listener ID	`listenerId`	`string`	The ID of the component or workflow you'd like to receive events

Action Authentication#

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

About Pipedream#

Integration platform for developers

More Ways to Connect Pipedream + Vitally#

Other Popular Integrations#

Create Message with Vitally API on New Scheduled Tasks from Pipedream API

Pipedream + Vitally

Delete a Subscription with Pipedream API on New User Created from Vitally API

Pipedream makes it easy to connect APIs for Pipedream, Vitally 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