Create or Update User with Vero API on Employee Updated from Breathe API

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

Trigger workflow on

Employee Updated from the Breathe API

Next, do this

Create or Update User with the Vero 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 Breathe trigger and Vero action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Employee Updated trigger
1. Connect your Breathe account
2. Configure timer
Configure the Create or Update User action
1. Connect your Vero account
2. Configure ID
3. Configure Email
4. Optional- Configure Channels
5. Optional- Configure Data
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#

Employee Updated on Breathe

Description:Emit new event when an existing employee is updated in Breathe. [See the documentation](https://developer.breathehr.com/examples#!/employees/GET_version_employees_json)

Version:0.0.1

Key:breathe-employee-updated

View on GitHub

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "breathe-employee-updated",
  name: "Employee Updated",
  description: "Emit new event when an existing employee is updated in Breathe. [See the documentation](https://developer.breathehr.com/examples#!/employees/GET_version_employees_json)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTsField() {
      return "updated_at";
    },
    getResourceFn() {
      return this.breathe.listEmployees;
    },
    getResourceKey() {
      return "employees";
    },
    isRelevant(employee) {
      return !(employee.created_at === employee.updated_at);
    },
    generateMeta(employee) {
      const ts = Date.parse(employee.updated_at);
      return {
        id: `${employee.id}-${ts}`,
        summary: `Employee Updated: ${employee.first_name} ${employee.last_name}`,
        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
Breathe	`breathe`	`app`	This component uses the Breathe app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About Breathe#

HR Software That Puts People First.

Action#

Create or Update User on Vero

Description:This endpoint creates a new user profile if the user doesn't exist yet. Otherwise, the user profile is updated based on the properties provided. [See the documentation](https://developers.getvero.com/track-api-reference/#/operations/identify)

Version:0.0.2

Key:vero-create-or-update-user

View on GitHub

Vero Overview#

Vero's API allows you to automate email marketing tasks such as managing campaigns, users, and events. Integrating Vero with Pipedream enables you to create workflows that respond to various triggers, like webhooks or schedules, and carry out actions such as sending emails, segmenting users, or tracking events. This integration can be a powerful tool to personalize your marketing efforts and respond in real-time to your customers' interactions.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import app from "../../vero.app.mjs";

export default {
  type: "action",
  key: "vero-create-or-update-user",
  name: "Create or Update User",
  version: "0.0.2",
  description: "This endpoint creates a new user profile if the user doesn't exist yet. Otherwise, the user profile is updated based on the properties provided. [See the documentation](https://developers.getvero.com/track-api-reference/#/operations/identify)",
  props: {
    app,
    id: {
      propDefinition: [
        app,
        "id",
      ],
    },
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    channels: {
      type: "string[]",
      label: "Channels",
      description: "A valid JSON array containing hashes of key/value pairs that represent the user's device token. Each hash should represent a single device token and include the fields type, address, and platform. Ex: `{\"type\":\"push\", \"address\":\"UNIQUE_DEVICE_TOKEN\", \"platform\":\"android\"}`",
      optional: true,
    },
    data: {
      type: "object",
      label: "Data",
      description: "A valid JSON hash containing key value pairs that represent the custom user properties you want to update. The locale, timezone and userAgent attributes are reserved properties that may be updated automatically by our SDKs. You can use these properties but bear in mind they may be overwritten if using our SDKs or integrations. All other keys are freeform and can be defined by you. Ex: `{\"first_name\":\"Damien\",\"last_name\":\"Brzoska\",\"timezone\":-10}`",
      optional: true,
    },
  },
  methods: {
    parseChannels(data) {
      if (!data) {
        return null;
      }
      const parsed = [];
      for (let i = 0; i < data.length; i++) {
        let item;
        try {
          item = JSON.parse(data[i]);
        } catch (err) {
          throw new ConfigurationError(`Invalid JSON in channels property at index ${i}: ${err.message}`);
        }

        if (Array.isArray(item)) {
          throw new ConfigurationError(`Invalid JSON in channels property at index ${i}: Expected an object, but received an array. If you want to send multiple items, please create a new child`);
        }

        parsed.push(item);
      }

      return parsed;
    },
  },
  async run({ $ }) {
    const {
      app,
      parseChannels,
      ...rest
    } = this;
    const res = await app.createOrUpdateUser({
      ...rest,
      channels: parseChannels(rest.channels),
    });
    $.export("summary", `User with id "${rest.id}" created or updated successfully`);
    return res;
  },
};

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
Vero	`app`	`app`	This component uses the Vero app.
ID	`id`	`string`	The unique identifier of the customer.
Email	`email`	`string`	The email address of the customer.
Channels	`channels`	`string[]`	A valid JSON array containing hashes of key/value pairs that represent the user's device token. Each hash should represent a single device token and include the fields type, address, and platform. Ex: `{"type":"push", "address":"UNIQUE_DEVICE_TOKEN", "platform":"android"}`
Data	`data`	`object`	A valid JSON hash containing key value pairs that represent the custom user properties you want to update. The locale, timezone and userAgent attributes are reserved properties that may be updated automatically by our SDKs. You can use these properties but bear in mind they may be overwritten if using our SDKs or integrations. All other keys are freeform and can be defined by you. Ex: `{"first_name":"Damien","last_name":"Brzoska","timezone":-10}`

Action Authentication#

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

To retrieve your Auth Token,

Navigate to your Vero account and sign in
Go to “Configuration” > “Settings” > “Project Details” > "API Credentials" > Auth Token

About Vero#

Game-changing multi-channel messaging tools for the next generation of marketers.

More Ways to Connect Vero + Breathe#

Other Popular Integrations#

Track Event for User with Vero API on Employee Updated from Breathe API

Breathe + Vero

Try it

Track Event for User with Vero API on New Leave Request Created from Breathe API

Breathe + Vero

Try it

Track Event for User with Vero API on New Employee Created from Breathe API

Breathe + Vero

Try it

Create or Update User with Vero API on New Leave Request Created from Breathe API

Breathe + Vero

Try it

Create or Update User with Vero API on New Employee Created from Breathe API

Breathe + Vero

Try it

Popular Triggers#

Employee Updated from the Breathe API

Emit new event when an existing employee is updated in Breathe. See the documentation

Try it

New Employee Created from the Breathe API

Emit new event when a new employee is created in Breathe. See the documentation

Try it

New Leave Request Created from the Breathe API

Emit new event when a new employee leave request is created in Breathe. See the documentation

Try it

Popular Actions#

Approve or Reject Leave Request with the Breathe API

Approve or reject an employee leave request in Breathe. See the documentation

Try it

Create Employee with the Breathe API

Creates a new employee in Breathe. See the documentation

Try it

Create Leave Request with the Breathe API

Creates a new leave request for an employee in Breathe. See the documentation

Try it

Create or Update User with the Vero API

This endpoint creates a new user profile if the user doesn't exist yet. Otherwise, the user profile is updated based on the properties provided. See the documentation

Try it

Track Event for User with the Vero API

This endpoint tracks an event for a specific user. If the user profile doesn't exist Vero will create it. See the documentation

Try it