Create New List with Klaviyo API on New Dismissal from Convenia API

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

Trigger workflow on

New Dismissal from the Convenia API

Next, do this

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

Select this integration
Configure the New Dismissal trigger
1. Connect your Convenia account
2. Configure timer
Configure the Create New List action
1. Connect your Klaviyo account
2. Configure List 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 Dismissal on Convenia

Description:Emit new event when an employee is dismissed.

Version:0.0.1

Key:convenia-new-dismissal

View on GitHub

Convenia Overview#

The Convenia API offers a suite of HR management functionalities, allowing for the automation of employee onboarding, payroll management, and other HR tasks. By integrating with Convenia via Pipedream, you can streamline HR operations, sync employee data across applications, and trigger actions based on various HR events. Pipedream's serverless platform facilitates the creation of complex workflows to interact with the Convenia API, enabling developers and HR professionals to build custom automations without managing infrastructure.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import convenia from "../../convenia.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "convenia-new-dismissal",
  name: "New Dismissal",
  description: "Emit new event when an employee is dismissed.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    convenia,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || "1970-01-01";
    },
    _setLastDate(LastDate) {
      this.db.set("lastDate", LastDate);
    },
    async startEvent(maxResults = false) {
      const lastDate = this._getLastDate();
      let count = 0;
      let tempDate = lastDate;

      const { data: dismissedEmployees } = await this.convenia.getEmployeesTerminated({
        params: {
          from_date: lastDate,
        },
      });

      for (const employee of dismissedEmployees) {
        if (maxResults && (++count >= maxResults)) break;

        if (Date.parse(employee.dismissal.date) > Date.parse(tempDate)) {
          tempDate = employee.dismissal.date;
        }

        this.$emit(employee, {
          id: employee.dismissal.id,
          summary: `New Dismissal with ID: ${employee.dismissal.id}`,
          ts: Date.now(employee.dismissal.date),
        });
      }
      this._setLastDate(tempDate);
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
  sampleEmit,
};

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
Convenia	`convenia`	`app`	This component uses the Convenia app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To retrieve your API token,
* Navigate to your Convenia account and sign in
* Go to “Configurações” > “API”

About Convenia#

Convenia is a cloud people management software for small business that increase its efficiency and eliminating operational labor.

Action#

Create New List on Klaviyo

Description:Creates a new list in an account. [See the docs here](https://developers.klaviyo.com/en/v1-2/reference/create-list)

Version:0.0.2

Key:klaviyo-create-new-list

View on GitHub

Klaviyo Overview#

The Klaviyo API grants you the power to automate and personalize your email marketing efforts. With it, you can manage lists, profiles, and campaigns, track event-driven communications, and analyze the results. By leveraging this API on Pipedream, you can create intricate, automated workflows that respond in real-time to your users' behavior, sync data across multiple platforms, and tailor your marketing strategies to improve engagement and conversion rates.

Action Code#

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

export default {
  key: "klaviyo-create-new-list",
  name: "Create New List",
  description: "Creates a new list in an account. [See the docs here](https://developers.klaviyo.com/en/v1-2/reference/create-list)",
  version: "0.0.2",
  type: "action",
  props: {
    klaviyo,
    listName: {
      propDefinition: [
        klaviyo,
        "listName",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.klaviyo.newList({
      data: {
        type: "list",
        attributes: {
          name: this.listName,
        },
      },
    });

    $.export("$summary", `"${this.listName}" successfully created!`);
    return response.body;
  },
};