List Invoices with Zoho Books API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for Zoho Books, Slack and 2,500+ other apps remarkably fast.

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

List Invoices with the Zoho Books 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 Slack trigger and Zoho Books 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 In Channels (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Optional- Configure Resolve Names
5. Optional- Configure Ignore Bots
6. Optional- Configure Ignore replies in threads
Configure the List Invoices action
1. Connect your Zoho Books account
2. Optional- Configure Invoice Number
3. Optional- Configure Item Name
4. Optional- Configure Item Id
5. Optional- Configure Item Description
6. Optional- Configure Reference Number
7. Optional- Configure Customer Name
8. Optional- Configure Recurring Invoice Id
9. Optional- Configure Email
10. Optional- Configure Total
11. Optional- Configure Balance
12. Optional- Configure Custom Field
13. Optional- Configure Date
14. Optional- Configure Due Date
15. Optional- Configure Last Modified Time
16. Optional- Select a Status
17. Optional- Configure Customer Id
18. Optional- Select a Filter By
19. Optional- Configure Search Text
20. Optional- Select a Sort Column
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 In Channels (Instant) on Slack

Description:Emit new event when a new message is posted to one or more channels

Version:1.0.24

Key:slack-new-message-in-channels

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. Once you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Automate posting updates to your team channels
Create a bot to answer common questions
Integrate with your existing tools and services
And much more!

Trigger Code#

import common from "../common/base.mjs";
import constants from "../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "slack-new-message-in-channels",
  name: "New Message In Channels (Instant)",
  version: "1.0.24",
  description: "Emit new event when a new message is posted to one or more channels",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Select one or more channels to monitor for new messages.",
      optional: true,
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return this.conversations || [
          "message",
        ];
      },
    },
    resolveNames: {
      propDefinition: [
        common.props.slack,
        "resolveNames",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
    ignoreThreads: {
      type: "boolean",
      label: "Ignore replies in threads",
      description: "Ignore replies to messages in threads",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New message in channel";
    },
    async processEvent(event) {
      if (event.type !== "message") {
        console.log(`Ignoring event with unexpected type "${event.type}"`);
        return;
      }
      if (event.subtype && !constants.ALLOWED_MESSAGE_IN_CHANNEL_SUBTYPES.includes(event.subtype)) {
        // This source is designed to just emit an event for each new message received.
        // Due to inconsistencies with the shape of message_changed and message_deleted
        // events, we are ignoring them for now. If you want to handle these types of
        // events, feel free to change this code!!
        console.log("Ignoring message with subtype.");
        return;
      }
      if ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) {
        return;
      }
      // There is no thread message type only the thread_ts field
      // indicates if the message is part of a thread in the event.
      if (this.ignoreThreads && event.thread_ts) {
        console.log("Ignoring reply in thread");
        return;
      }
      if (this.resolveNames) {
        if (event.user) {
          event.user_id = event.user;
          event.user = await this.getUserName(event.user);
        } else if (event.bot_id) {
          event.bot = await this.getBotName(event.bot_id);
        }
        event.channel_id = event.channel;
        event.channel = await this.getConversationName(event.channel);
        if (event.team) {
          event.team_id = event.team;
          event.team = await this.getTeamName(event.team);
        }
      }
      return event;
    },
  },
  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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`
Resolve Names	`resolveNames`	`boolean`	Instead of returning `channel`, `team`, and `user` as IDs, return their human-readable names.
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots
Ignore replies in threads	`ignoreThreads`	`boolean`	Ignore replies to messages in threads

Trigger Authentication#

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

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

channels:historychannels:readchannels:writeemoji:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writereactions:readreactions:writereminders:readreminders:writestars:readteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:userfiles:write:usercommandsusers.profile:writeusers.profile:readsearch:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

Action#

List Invoices on Zoho Books

Description:Lists all invoices. [See the documentation](https://www.zoho.com/books/api/v3/contacts/#list-contacts)

Version:0.3.0

Key:zoho_books-list-invoices

View on GitHub

Zoho Books Overview#

Zoho Books API unlocks the potential to automate and streamline accounting tasks by integrating with Pipedream's serverless platform. With this powerful combo, you can automate invoicing, manage your accounts, reconcile bank transactions, and handle contacts and items without manual input. By setting up event-driven workflows, you can ensure data consistency across platforms, trigger notifications, and generate reports, all while saving time and reducing human error.

Action Code#

// legacy_hash_id: a_PNin2N// legacy_hash_id: a_RAiV28
import {
  INVOICE_FILTER_BY_OPTIONS,
  INVOICE_SORT_COLUMN_OPTIONS,
  INVOICE_STATUS_OPTIONS,
} from "../../common/constants.mjs";
import zohoBooks from "../../zoho_books.app.mjs";

export default {
  key: "zoho_books-list-invoices",
  name: "List Invoices",
  description: "Lists all invoices. [See the documentation](https://www.zoho.com/books/api/v3/contacts/#list-contacts)",
  version: "0.3.0",
  type: "action",
  props: {
    zohoBooks,
    invoiceNumber: {
      type: "string",
      label: "Invoice Number",
      description: "Search invoices by invoice number. Max-length [100]",
      optional: true,
    },
    itemName: {
      type: "string",
      label: "Item Name",
      description: "Search invoices by item name. Max-length [100]",
      optional: true,
    },
    itemId: {
      type: "string",
      label: "Item Id",
      description: "Search invoices by item id.",
      optional: true,
    },
    itemDescription: {
      type: "string",
      label: "Item Description",
      description: "Search invoices by item description. Max-length [100]",
      optional: true,
    },
    referenceNumber: {
      type: "string",
      label: "Reference Number",
      description: "The reference number of the invoice.",
      optional: true,
    },
    customerName: {
      type: "string",
      label: "Customer Name",
      description: "The name of the customer. Max-length [100]",
      optional: true,
    },
    recurringInvoiceId: {
      type: "string",
      label: "Recurring Invoice Id",
      description: "ID of the recurring invoice from which the invoice is created.",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "Search contacts by email id. Max-length [100]",
      optional: true,
    },
    total: {
      type: "string",
      label: "Total",
      description: "The total amount to be paid.",
      optional: true,
    },
    balance: {
      type: "string",
      label: "Balance",
      description: "The unpaid amount.",
      optional: true,
    },
    customField: {
      type: "string",
      label: "Custom Field",
      description: "Search invoices by custom fields.",
      optional: true,
    },
    date: {
      type: "string",
      label: "Date",
      description: "Search invoices by invoice date. Default date format is `yyyy-mm-dd`.",
      optional: true,
    },
    dueDate: {
      type: "string",
      label: "Due Date",
      description: "Search invoices by due date. Default date format is `yyyy-mm-dd`.",
      optional: true,
    },
    lastModifiedTime: {
      type: "string",
      label: "Last Modified Time",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "Search invoices by invoice status.",
      options: INVOICE_STATUS_OPTIONS,
      optional: true,
    },
    customerId: {
      type: "string",
      label: "Customer Id",
      description: "ID of the customer the invoice has to be created.",
      optional: true,
    },
    filterBy: {
      type: "string",
      label: "Filter By",
      description: "Filter invoices by any status or payment expected date.",
      optional: true,
      options: INVOICE_FILTER_BY_OPTIONS,
    },
    searchText: {
      type: "string",
      label: "Search Text",
      description: "Search invoices by invoice number or purchase order or customer name. Max-length [100]",
      optional: true,
    },
    sortColumn: {
      type: "string",
      label: "Sort Column",
      description: "Sort invoices.",
      options: INVOICE_SORT_COLUMN_OPTIONS,
      optional: true,
    },
  },
  async run({ $ }) {
    const response = this.zohoBooks.paginate({
      fn: this.zohoBooks.listInvoices,
      fieldName: "invoices",
      params: {
        invoice_number: this.invoiceNumber,
        item_name: this.itemName,
        item_id: this.itemId,
        item_description: this.itemDescription,
        reference_number: this.referenceNumber,
        customer_name: this.customerName,
        recurring_invoice_id: this.recurringInvoiceId,
        email: this.email,
        total: this.total,
        balance: this.balance,
        custom_field: this.customField,
        date: this.date,
        due_date: this.dueDate,
        last_modified_time: this.lastModifiedTime,
        status: this.status,
        customer_id: this.customerId,
        filter_by: this.filterBy,
        search_text: this.searchText,
        sort_column: this.sortColumn,
      },
    });

    const responseArray = [];
    for await (const item of response) {
      responseArray.push(item);
    }

    $.export("$summary", `Successfully fetched ${responseArray.length} invoices(s)`);
    return responseArray;
  },
};

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
Zoho Books	`zohoBooks`	`app`	This component uses the Zoho Books app.
Invoice Number	`invoiceNumber`	`string`	Search invoices by invoice number. Max-length [100]
Item Name	`itemName`	`string`	Search invoices by item name. Max-length [100]
Item Id	`itemId`	`string`	Search invoices by item id.
Item Description	`itemDescription`	`string`	Search invoices by item description. Max-length [100]
Reference Number	`referenceNumber`	`string`	The reference number of the invoice.
Customer Name	`customerName`	`string`	The name of the customer. Max-length [100]
Recurring Invoice Id	`recurringInvoiceId`	`string`	ID of the recurring invoice from which the invoice is created.
Email	`email`	`string`	Search contacts by email id. Max-length [100]
Total	`total`	`string`	The total amount to be paid.
Balance	`balance`	`string`	The unpaid amount.
Custom Field	`customField`	`string`	Search invoices by custom fields.
Date	`date`	`string`	Search invoices by invoice date. Default date format is `yyyy-mm-dd`.
Due Date	`dueDate`	`string`	Search invoices by due date. Default date format is `yyyy-mm-dd`.
Last Modified Time	`lastModifiedTime`	`string`
Status	`status`	`string`	Select a value from the drop down menu:`sentdraftoverduepaidvoidunpaidpartially_paidviewed`
Customer Id	`customerId`	`string`	ID of the customer the invoice has to be created.
Filter By	`filterBy`	`string`	Select a value from the drop down menu:`Status.AllStatus.SentStatus.DraftStatus.OverDueStatus.PaidStatus.VoidStatus.UnpaidStatus.PartiallyPaidStatus.ViewedDate.PaymentExpectedDate`
Search Text	`searchText`	`string`	Search invoices by invoice number or purchase order or customer name. Max-length [100]
Sort Column	`sortColumn`	`string`	Select a value from the drop down menu:`customer_nameinvoice_numberdatedue_datetotalbalancecreated_time`

Action Authentication#

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

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

ZohoBooks.fullaccess.all

List Invoices with Zoho Books API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for Zoho Books, Slack and 2,500+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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