Create Device Return with Retriever API on New Posted Credit Note (Instant) from Workbooks CRM API

Pipedream makes it easy to connect APIs for Retriever, Workbooks CRM and 2,700+ other apps remarkably fast.

Trigger workflow on

New Posted Credit Note (Instant) from the Workbooks CRM API

Next, do this

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

Select this integration
Configure the New Posted Credit Note (Instant) trigger
1. Connect your Workbooks CRM account
Configure the Create Device Return action
1. Connect your Retriever account
2. Configure Request Charger
3. Optional- Configure Employee Info Email
4. Configure Employee Info Name
5. Configure Employee Info Address Line 1
6. Optional- Configure Employee Info Address Line 2
7. Optional- Configure Employee Info Address City
8. Optional- Configure Employee Info Address State
9. Optional- Configure Employee Info Address Zip
10. Configure Company Info Return Recipient Name
11. Optional- Configure Company Info Return Address Company
12. Configure Company Info Return Address Line 1
13. Optional- Configure Company Info Return Address Line 2
14. Optional- Configure Company Info Return Address City
15. Optional- Configure Company Info Return Address State
16. Optional- Configure Company Info Return Address Zip
17. Configure Company Info Display Name
18. Optional- Configure Company Info Notification Email
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 Posted Credit Note (Instant) on Workbooks CRM

Description:Emit new event when a new credit note is posted.

Version:0.0.1

Key:workbooks_crm-posted-credit-note

View on GitHub

Workbooks CRM Overview#

The Workbooks CRM API unlocks a treasure trove of possibilities for automating customer relationship management tasks. With this API, you can seamlessly sync contact info, manage sales leads, automate follow-up tasks, and build custom reports to unlock actionable insights. Harnessing the power of the Workbooks CRM API on Pipedream allows you to supercharge these functionalities, triggering workflows on custom events, and connecting to numerous other apps to streamline your CRM processes even further.

Trigger Code#

import common from "../common-webhook.mjs";
import constants from "../../common/constants.mjs";

export default {
  ...common,
  key: "workbooks_crm-posted-credit-note",
  name: "New Posted Credit Note (Instant)",
  description: "Emit new event when a new credit note is posted.",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.app.getCreditNotes;
    },
    getResourceFnArgs() {
      return {
        params: {
          _ff: [
            "status",
          ],
          _ft: [
            "eq",
          ],
          _fc: [
            "POSTED",
          ],
        },
      };
    },
    getResourceName() {
      return "creditnote";
    },
    getTriggerId() {
      return constants.TRIGGER_ID.POSTED_CREDIT_NOTE;
    },
    getMetadata(resource) {
      return {
        id: resource.id,
        ts: Date.parse(resource.created_at),
        summary: `New Credit Note ID ${resource.id}`,
      };
    },
  },
};

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
Workbooks CRM	`app`	`app`	This component uses the Workbooks CRM app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

Trigger Authentication#

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

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

About Workbooks CRM#

Workbooks offers an end-to-end CRM platform designed specifically for small & mid-size businesses.

Action#

Create Device Return on Retriever

Description:Creates a device return order. [See the documentation](https://app.helloretriever.com/api/v1/docs/#tag/Device-Return-Orders/operation/Submit%20Order)

Version:0.0.1

Key:retriever-create-device-return

View on GitHub

Retriever Overview#

The Retriever API is designed for automating contact information retrieval, enriching your CRM data, or building lead generation tools. By integrating it with Pipedream, you can strategically extract valuable data and automate workflows for marketing, sales, or customer support. Pipedream’s serverless platform enables you to connect Retriever with hundreds of other apps, triggering actions based on new data, or updating systems in real-time.

Action Code#

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

export default {
  key: "retriever-create-device-return",
  name: "Create Device Return",
  description: "Creates a device return order. [See the documentation](https://app.helloretriever.com/api/v1/docs/#tag/Device-Return-Orders/operation/Submit%20Order)",
  type: "action",
  version: "0.0.1",
  props: {
    app,
    requestCharger: {
      type: "boolean",
      label: "Request Charger",
      description: "Whether or not to request a charger with the device return.",
    },
    employeeInfoEmail: {
      type: "string",
      label: "Employee Info Email",
      description: "Optional email address for notifying the employee when a box ships and is delivered, as well as sending reminders.",
      optional: true,
    },
    employeeInfoName: {
      type: "string",
      label: "Employee Info Name",
      description: "The employee name to print on the shipping label.",
    },
    employeeInfoAddressLine1: {
      type: "string",
      label: "Employee Info Address Line 1",
      description: "The first line of the employee's address (typically the street address), or a full, comma-separated address. If providing the *Employee Info Address Line 1*, *Employee Info Address City*, *Employee Info Address State*, and *Employee Info Address Zip* are required (*Employee Info Address Line 2* remains optional). If providing a full address, it is best to use the format `1 Main St, New York, NY 10001` or `1 Main St, Apt 200, New York, NY 10001`. We will attempt to parse any full address, but cannot guarantee accuracy - especially if other formats are used. It is highly recommended to provide the address in separate fields.",
    },
    employeeInfoAddressLine2: {
      type: "string",
      label: "Employee Info Address Line 2",
      description: "Optional second line of the employee's address.",
      optional: true,
    },
    employeeInfoAddressCity: {
      type: "string",
      label: "Employee Info Address City",
      description: "Optional if a full address is provided in *Employee Info Address Line 1*. Required otherwise.",
      optional: true,
    },
    employeeInfoAddressState: {
      type: "string",
      label: "Employee Info Address State",
      description: "Optional if a full address is provided in *Employee Info Address Line 1*. Required otherwise.",
      optional: true,
    },
    employeeInfoAddressZip: {
      type: "string",
      label: "Employee Info Address Zip",
      description: "Optional if a full address is provided in *Employee Info Address Line 1*. Required otherwise.",
      optional: true,
    },
    companyInfoReturnRecipientName: {
      type: "string",
      label: "Company Info Return Recipient Name",
      description: "The return recipient name to print on the shipping label.",
    },
    companyInfoReturnAddressCompany: {
      type: "string",
      label: "Company Info Return Address Company",
      description: "The return recipient company to print on the shipping label.",
      optional: true,
    },
    companyInfoReturnAddressLine1: {
      type: "string",
      label: "Company Info Return Address Line 1",
      description: "The first line of the return address (typically the street address), or a full, comma-separated address. If providing the *Company Info Return Address Line 1*, *Company Info Return Address City*, *Company Info Return Address State*, and *Company Info Return Address  Zip* are required (*Company Info Return Address Line 2* remains optional). If providing a full address, it is best to use the format `1 Main St, New York, NY 10001` or `1 Main St, Apt 200, New York, NY 10001`. We will attempt to parse any full address, but cannot guarantee accuracy - especially if other formats are used. It is highly recommended to provide the address in separate fields.",
    },
    companyInfoReturnAddressLine2: {
      type: "string",
      label: "Company Info Return Address Line 2",
      description: "Optional second line of the return address.",
      optional: true,
    },
    companyInfoReturnAddressCity: {
      type: "string",
      label: "Company Info Return Address City",
      description: "Optional if a full address is provided in *Company Info Return Address Line 1*. Required otherwise.",
      optional: true,
    },
    companyInfoReturnAddressState: {
      type: "string",
      label: "Company Info Return Address State",
      description: "Optional if a full address is provided in *Company Info Return Address Line 1*. Required otherwise.",
      optional: true,
    },
    companyInfoReturnAddressZip: {
      type: "string",
      label: "Company Info Return Address Zip",
      description: "Optional if a full address is provided in *Company Info Return Address Line 1*. Required otherwise.",
      optional: true,
    },
    companyInfoDisplayName: {
      type: "string",
      label: "Company Info Display Name",
      description: "Used in email communications with the employee.",
    },
    companyInfoNotificationEmail: {
      type: "string",
      label: "Company Info Notification Email",
      description: "Optional email address for updates on the status of this device return.",
      optional: true,
    },
  },
  methods: {
    createDeviceReturn(args = {}) {
      return this.app.post({
        path: "/device_returns/",
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      createDeviceReturn,
      requestCharger,
      employeeInfoEmail,
      employeeInfoName,
      employeeInfoAddressLine1,
      employeeInfoAddressLine2,
      employeeInfoAddressCity,
      employeeInfoAddressState,
      employeeInfoAddressZip,
      companyInfoReturnRecipientName,
      companyInfoReturnAddressCompany,
      companyInfoReturnAddressLine1,
      companyInfoReturnAddressLine2,
      companyInfoReturnAddressCity,
      companyInfoReturnAddressState,
      companyInfoReturnAddressZip,
      companyInfoDisplayName,
      companyInfoNotificationEmail,
    } = this;

    const response = await createDeviceReturn({
      step,
      data: {
        request_charger: requestCharger,
        employee_info: {
          email: employeeInfoEmail,
          name: employeeInfoName,
          address_line_1: employeeInfoAddressLine1,
          address_line_2: employeeInfoAddressLine2,
          address_city: employeeInfoAddressCity,
          address_state: employeeInfoAddressState,
          address_zip: employeeInfoAddressZip,
        },
        company_info: {
          return_recipient_name: companyInfoReturnRecipientName,
          return_address_company: companyInfoReturnAddressCompany,
          return_address_line_1: companyInfoReturnAddressLine1,
          return_address_line_2: companyInfoReturnAddressLine2,
          return_address_city: companyInfoReturnAddressCity,
          return_address_state: companyInfoReturnAddressState,
          return_address_zip: companyInfoReturnAddressZip,
          display_name: companyInfoDisplayName,
          notification_email: companyInfoNotificationEmail,
        },
      },
    });

    step.export("$summary", `Successfully created device return order with ID \`${response.id}\``);

    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
Retriever	`app`	`app`	This component uses the Retriever app.
Request Charger	`requestCharger`	`boolean`	Whether or not to request a charger with the device return.
Employee Info Email	`employeeInfoEmail`	`string`	Optional email address for notifying the employee when a box ships and is delivered, as well as sending reminders.
Employee Info Name	`employeeInfoName`	`string`	The employee name to print on the shipping label.
Employee Info Address Line 1	`employeeInfoAddressLine1`	`string`	The first line of the employee's address (typically the street address), or a full, comma-separated address. If providing the Employee Info Address Line 1, Employee Info Address City, Employee Info Address State, and Employee Info Address Zip are required (Employee Info Address Line 2 remains optional). If providing a full address, it is best to use the format `1 Main St, New York, NY 10001` or `1 Main St, Apt 200, New York, NY 10001`. We will attempt to parse any full address, but cannot guarantee accuracy - especially if other formats are used. It is highly recommended to provide the address in separate fields.
Employee Info Address Line 2	`employeeInfoAddressLine2`	`string`	Optional second line of the employee's address.
Employee Info Address City	`employeeInfoAddressCity`	`string`	Optional if a full address is provided in Employee Info Address Line 1. Required otherwise.
Employee Info Address State	`employeeInfoAddressState`	`string`	Optional if a full address is provided in Employee Info Address Line 1. Required otherwise.
Employee Info Address Zip	`employeeInfoAddressZip`	`string`	Optional if a full address is provided in Employee Info Address Line 1. Required otherwise.
Company Info Return Recipient Name	`companyInfoReturnRecipientName`	`string`	The return recipient name to print on the shipping label.
Company Info Return Address Company	`companyInfoReturnAddressCompany`	`string`	The return recipient company to print on the shipping label.
Company Info Return Address Line 1	`companyInfoReturnAddressLine1`	`string`	The first line of the return address (typically the street address), or a full, comma-separated address. If providing the Company Info Return Address Line 1, Company Info Return Address City, Company Info Return Address State, and Company Info Return Address Zip are required (Company Info Return Address Line 2 remains optional). If providing a full address, it is best to use the format `1 Main St, New York, NY 10001` or `1 Main St, Apt 200, New York, NY 10001`. We will attempt to parse any full address, but cannot guarantee accuracy - especially if other formats are used. It is highly recommended to provide the address in separate fields.
Company Info Return Address Line 2	`companyInfoReturnAddressLine2`	`string`	Optional second line of the return address.
Company Info Return Address City	`companyInfoReturnAddressCity`	`string`	Optional if a full address is provided in Company Info Return Address Line 1. Required otherwise.
Company Info Return Address State	`companyInfoReturnAddressState`	`string`	Optional if a full address is provided in Company Info Return Address Line 1. Required otherwise.
Company Info Return Address Zip	`companyInfoReturnAddressZip`	`string`	Optional if a full address is provided in Company Info Return Address Line 1. Required otherwise.
Company Info Display Name	`companyInfoDisplayName`	`string`	Used in email communications with the employee.
Company Info Notification Email	`companyInfoNotificationEmail`	`string`	Optional email address for updates on the status of this device return.

Create Device Return with Retriever API on New Posted Credit Note (Instant) from Workbooks CRM API

Pipedream makes it easy to connect APIs for Retriever, Workbooks CRM and 2,700+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular