Create Associations with HubSpot API on New Dismissal from Convenia API

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

Trigger workflow on

New Dismissal from the Convenia API

Next, do this

Create Associations with the HubSpot 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 HubSpot 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 Associations action
1. Connect your HubSpot account
2. Select a From Object Type
3. Select a From Object
4. Select a To Object Type
5. Select a Association Type
6. Select one or more To Objects
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 Associations on HubSpot

Description:Create associations between objects. [See the documentation](https://developers.hubspot.com/docs/api/crm/associations#endpoint?spec=POST-/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create)

Version:0.0.11

Key:hubspot-create-associations

View on GitHub

HubSpot Overview#

The HubSpot API enables developers to integrate into HubSpots CRM, CMS, Conversations, and other features. It allows for automated management of contacts, companies, deals, and marketing campaigns, enabling custom workflows, data synchronization, and task automation. This streamlines operations and boosts customer engagement, with real-time updates for rapid response to market changes.

Action Code#

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

export default {
  key: "hubspot-create-associations",
  name: "Create Associations",
  description: "Create associations between objects. [See the documentation](https://developers.hubspot.com/docs/api/crm/associations#endpoint?spec=POST-/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create)",
  version: "0.0.11",
  type: "action",
  props: {
    hubspot,
    fromObjectType: {
      propDefinition: [
        hubspot,
        "objectType",
        () => ({
          includeCustom: true,
        }),
      ],
      label: "From Object Type",
      description: "The type of the object being associated",
    },
    fromObjectId: {
      propDefinition: [
        hubspot,
        "objectIds",
        (configuredProps) => ({
          objectType: configuredProps.fromObjectType,
        }),
      ],
      type: "string",
      label: "From Object",
      description: "The ID of the object being associated",
    },
    toObjectType: {
      propDefinition: [
        hubspot,
        "objectType",
        () => ({
          includeCustom: true,
        }),
      ],
      label: "To Object Type",
      description: "Type of the objects the from object is being associated with",
    },
    associationType: {
      propDefinition: [
        hubspot,
        "associationType",
        (configuredProps) => ({
          fromObjectType: configuredProps.fromObjectType,
          toObjectType: configuredProps.toObjectType,
        }),
      ],
    },
    toObjectIds: {
      propDefinition: [
        hubspot,
        "objectIds",
        (configuredProps) => ({
          objectType: configuredProps.toObjectType,
        }),
      ],
      label: "To Objects",
      description: "Id's of the objects the from object is being associated with",
    },
  },
  methods: {
    async getAssociationCategory({
      $, fromObjectType, toObjectType, associationType,
    }) {
      const { results } = await this.hubspot.getAssociationTypes({
        $,
        fromObjectType,
        toObjectType,
        associationType,
      });
      const association = results.find(({ typeId }) => typeId === this.associationType);
      return association.category;
    },
  },
  async run({ $ }) {
    const {
      fromObjectType,
      fromObjectId,
      toObjectType,
      associationType,
    } = this;
    let toObjectIds;
    if (Array.isArray(this.toObjectIds)) {
      toObjectIds = this.toObjectIds;
    } else {
      try {
        toObjectIds = JSON.parse(this.toObjectIds);
      } catch {
        throw new ConfigurationError("Could not parse \"To Objects\" array.");
      }
    }

    const associationCategory = await this.getAssociationCategory({
      $,
      fromObjectType,
      toObjectType,
      associationType,
    });
    const response = await this.hubspot.createAssociations({
      $,
      fromObjectType,
      toObjectType,
      data: {
        inputs: toObjectIds.map((toId) => ({
          from: {
            id: fromObjectId,
          },
          to: {
            id: toId,
          },
          types: [
            {
              associationCategory,
              associationTypeId: associationType,
            },
          ],
        })),
      },
    });
    const l = response.results.length;
    $.export("$summary", `Successfully created ${l} association${l === 1
      ? ""
      : "s"}`);
    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
HubSpot	`hubspot`	`app`	This component uses the HubSpot app.
From Object Type	`fromObjectType`	`string`	Select a value from the drop down menu.
From Object	`fromObjectId`	`string`	Select a value from the drop down menu.
To Object Type	`toObjectType`	`string`	Select a value from the drop down menu.
Association Type	`associationType`	`string`	Select a value from the drop down menu.
To Objects	`toObjectIds`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

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

business-intelligencecrm.lists.readcrm.lists.writecrm.objects.companies.readcrm.objects.companies.writecrm.objects.contacts.readcrm.objects.contacts.writecrm.objects.deals.readcrm.objects.deals.writecrm.objects.quotes.readcrm.objects.quotes.writecrm.objects.owners.readcrm.schemas.companies.readcrm.schemas.companies.writecrm.schemas.contacts.readcrm.schemas.contacts.writecrm.schemas.deals.readcrm.schemas.deals.writecrm.schemas.quotes.readconversations.readcrm.importfilesformsforms-uploaded-filesintegration-syncoauthtimeline

Create Associations with HubSpot API on New Dismissal from Convenia API

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