Create Contact with BenchmarkONE API on New Message from AMQP API

Pipedream makes it easy to connect APIs for BenchmarkONE, AMQP and 2,900+ other apps remarkably fast.

Trigger workflow on

New Message from the AMQP API

Next, do this

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

Select this integration
Configure the New Message trigger
1. Connect your AMQP account
2. Configure Timer
3. Configure Receiver Name
4. Configure Queue Name
Configure the Create Contact action
1. Connect your BenchmarkONE account
2. Optional- Configure First Name
3. Optional- Configure Last Name
4. Optional- Configure Title
5. Optional- Configure Company
6. Optional- Configure Work Email Address
7. Optional- Configure Home Email Address
8. Optional- Configure Work Phone
9. Optional- Configure Home Phone
10. Optional- Configure Work Address
11. Optional- Configure Home Address
12. Select a Status
13. Optional- Select a Temperature
14. Optional- Configure Website
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 Message on AMQP

Description:Emit new event for each new message in an [AMQP 1.0](https://www.amqp.org/sites/amqp.org/files/amqp.pdf) queue. [See the library example here](https://github.com/amqp/rhea-promise#receiving-a-message).

Version:0.0.2

Key:amqp-receive-message

View on GitHub

AMQP Overview#

AMQP (Advanced Message Queuing Protocol) is a flexible protocol designed for high-performance messaging. Integrating the AMQP API within Pipedream workflows allows for robust messaging capabilities between various systems and services. You can use it to queue tasks, run asynchronous job processing, and facilitate communication between different parts of your application or different applications altogether. AMQP's reliability and standardization make it a go-to choice for enterprise-level messaging patterns.

Trigger Code#

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

export default {
  key: "amqp-receive-message",
  name: "New Message",
  description: "Emit new event for each new message in an [AMQP 1.0](https://www.amqp.org/sites/amqp.org/files/amqp.pdf) queue. [See the library example here](https://github.com/amqp/rhea-promise#receiving-a-message).",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  props: {
    amqp,
    timer: {
      type: "$.interface.timer",
      label: "Timer",
      description: "The timer to use to schedule the next poll.",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    receiverName: {
      type: "string",
      label: "Receiver Name",
      description: "The name of the receiver. e.g. (`my-receiver`)",
    },
    queueName: {
      propDefinition: [
        amqp,
        "queueName",
      ],
    },
  },
  async run(event) {
    const { timestamp } = event;
    const {
      host,
      port,
      username,
      password,
    } = this.amqp.$auth;

    const {
      receiverName,
      queueName,
    } = this;

    const connection = await this.amqp.openConnection({
      host,
      port,
      username,
      password,
    });

    console.log("Create receiver");
    const receiver = await this.amqp.createReceiver({
      connection,
      name: receiverName,
      source: {
        address: queueName,
      },
      onSessionError: (context) => {
        throw context.session.error ?? "Unknown Session Error";
      },
    });

    try {
      const messages = await this.amqp.onMessageReceiver(receiver);

      messages.forEach((message, idx) => {
        const id = timestamp + idx;
        this.$emit(message, {
          id,
          ts: id,
          summary: `New Message ${message.message_id}`,
        });
      });

    } catch (error) {
      if (error.innerError) {
        console.log("Inner error", JSON.stringify(error.innerError));
      }
      throw error;

    } finally {
      await this.amqp.close(receiver);
      await this.amqp.close(connection);
    }
  },
};

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
AMQP	`amqp`	`app`	This component uses the AMQP app.
Timer	`timer`	`$.interface.timer`	The timer to use to schedule the next poll.
Receiver Name	`receiverName`	`string`	The name of the receiver. e.g. (`my-receiver`)
Queue Name	`queueName`	`string`	The name of the queue to send the message to.

Trigger Authentication#

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

Setting up AMQP requires their users enter their AMQP settings host, post, username, and password in order to connect. For more info, refer to AMQP’s documentation

About AMQP#

AMQP (Advanced Message Queuing Protocol) Standard is a commonly used messaging protocol used in the open-source application development process.

Action#

Create Contact on BenchmarkONE

Description:Creates a new contact in BenchmarkONE. [See the documentation](https://sandbox.hatchbuck.com/api/dist/#!/Contacts/post_contact)

Version:0.0.2

Key:benchmarkone-create-contact

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import benchmarkone from "../../benchmarkone.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "benchmarkone-create-contact",
  name: "Create Contact",
  description: "Creates a new contact in BenchmarkONE. [See the documentation](https://sandbox.hatchbuck.com/api/dist/#!/Contacts/post_contact)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    benchmarkone,
    firstName: {
      propDefinition: [
        benchmarkone,
        "firstName",
      ],
      optional: true,
    },
    lastName: {
      propDefinition: [
        benchmarkone,
        "lastName",
      ],
      optional: true,
    },
    title: {
      propDefinition: [
        benchmarkone,
        "title",
      ],
      optional: true,
    },
    company: {
      propDefinition: [
        benchmarkone,
        "company",
      ],
      optional: true,
    },
    workEmail: {
      propDefinition: [
        benchmarkone,
        "workEmail",
      ],
      optional: true,
    },
    homeEmail: {
      propDefinition: [
        benchmarkone,
        "homeEmail",
      ],
      optional: true,
    },
    workPhone: {
      propDefinition: [
        benchmarkone,
        "workPhone",
      ],
      optional: true,
    },
    homePhone: {
      propDefinition: [
        benchmarkone,
        "homePhone",
      ],
      optional: true,
    },
    workAddress: {
      propDefinition: [
        benchmarkone,
        "workAddress",
      ],
      optional: true,
    },
    homeAddress: {
      propDefinition: [
        benchmarkone,
        "homeAddress",
      ],
      optional: true,
    },
    status: {
      propDefinition: [
        benchmarkone,
        "status",
      ],
    },
    temperature: {
      propDefinition: [
        benchmarkone,
        "temperature",
      ],
      optional: true,
    },
    website: {
      propDefinition: [
        benchmarkone,
        "website",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const emails = [];
      if (this.workEmail) {
        emails.push({
          address: this.workEmail,
          type: "Work",
        });
      }
      if (this.homeEmail) {
        emails.push({
          address: this.homeEmail,
          type: "Home",
        });
      }
      const phones = [];
      if (this.workPhone) {
        phones.push({
          number: this.workPhone,
          type: "Work",
        });
      }
      if (this.homePhone) {
        phones.push({
          number: this.homePhone,
          type: "Home",
        });
      }
      const addresses = [];
      if (this.workAddress) {
        addresses.push({
          ...parseObject(this.workAddress),
          type: "Work",
        });
      }
      if (this.homeAddress) {
        addresses.push({
          ...parseObject(this.homeAddress),
          type: "Home",
        });
      }

      const data = {
        contactId: this.contactId,
        firstName: this.firstName,
        lastName: this.lastName,
        emails,
        phones,
        addresses,
      };
      if (this.status) {
        data.status = {
          name: this.status.label,
          id: this.status.value,
        };
      }
      if (this.temperature) {
        data.temperature = {
          name: this.temperature.label,
          id: this.temperature.value,
        };
      }
      if (this.website) {
        data.website = [
          {
            websiteUrl: this.website,
          },
        ];
      }
      const response = await this.benchmarkone.createContact({
        $,
        data,
      });
      $.export("$summary", `Created contact with ID: ${response.contactId}`);
      return response;
    } catch (error) {
      throw new ConfigurationError(`Failed to create contact: ${error.message}`);
    }
  },
};

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
BenchmarkONE	`benchmarkone`	`app`	This component uses the BenchmarkONE app.
First Name	`firstName`	`string`	Contact's first name.
Last Name	`lastName`	`string`	Contact's last name.
Title	`title`	`string`	The contact's title.
Company	`company`	`string`	The contact's company name.
Work Email Address	`workEmail`	`string`	A contact's work email address.
Home Email Address	`homeEmail`	`string`	A contact's home email address.
Work Phone	`workPhone`	`string`	A contact's work phone number.
Home Phone	`homePhone`	`string`	A contact's home phone number.
Work Address	`workAddress`	`object`	An object of contact's work address.
Home Address	`homeAddress`	`object`	An object of contact's home address.
Status	`status`	`string`	Select a value from the drop down menu.
Temperature	`temperature`	`string`	Select a value from the drop down menu.
Website	`website`	`string`	The contact's website.