Create Sales Order with Zoho Books API on New Subscriber Activation (Instant) from ConvertKit API

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

Trigger workflow on

New Subscriber Activation (Instant) from the ConvertKit API

Next, do this

Create Sales Order 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 ConvertKit 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 Subscriber Activation (Instant) trigger
1. Connect your ConvertKit account
Configure the Create Sales Order action
1. Connect your Zoho Books account
2. Configure organization_id
3. Configure customer_id
4. Optional- Configure line_items
5. Optional- Configure contact_persons
6. Optional- Configure date
7. Optional- Configure shipment_date
8. Optional- Configure custom_fields
9. Optional- Configure place_of_supply
10. Optional- Configure salesperson_id
11. Optional- Configure merchant_id
12. Optional- Configure gst_treatment
13. Optional- Configure gst_no
14. Optional- Configure is_inclusive_tax
15. Optional- Configure notes
16. Optional- Configure terms
17. Optional- Configure billing_address_id
18. Optional- Configure shipping_address_id
19. Optional- Configure crm_owner_id
20. Optional- Configure crm_custom_reference_id
21. Optional- Configure vat_treatment
22. Optional- Configure tax_treatment
23. Optional- Configure salesorder_number
24. Optional- Configure reference_number
25. Optional- Configure is_update_customer
26. Optional- Configure discount
27. Optional- Configure exchange_rate
28. Optional- Configure salesperson_name
29. Optional- Configure notes_default
30. Optional- Configure terms_default
31. Optional- Configure tax_id
32. Optional- Configure tax_authority_id
33. Optional- Configure tax_exemption_id
34. Optional- Configure tax_authority_name
35. Optional- Configure tax_exemption_code
36. Optional- Configure avatax_exempt_no
37. Optional- Configure avatax_use_code
38. Optional- Configure shipping_charge
39. Optional- Configure adjustment
40. Optional- Configure delivery_method
41. Optional- Configure estimate_id
42. Optional- Configure is_discount_before_tax
43. Optional- Configure discount_type
44. Optional- Configure adjustment_description
45. Optional- Configure pricebook_id
46. Optional- Configure template_id
47. Optional- Configure documents
48. Optional- Configure zcrm_potential_id
49. Optional- Configure zcrm_potential_name
50. Optional- Configure ignore_auto_number_generation
51. Optional- Configure can_send_in_mail
52. Optional- Configure totalFiles
53. Optional- Configure doc
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 Subscriber Activation (Instant) on ConvertKit

Description:Emit new event when a new subscriber is activated. [See docs here](https://developers.convertkit.com/#create-a-webhook)

Version:0.0.2

Key:convertkit-new-subscriber-instant

View on GitHub

ConvertKit Overview#

ConvertKit's API offers granular control over email marketing campaigns, allowing users to automate subscriber management, broadcast sending, and sequence setup. Utilize Pipedream's power to react to events, sync data across platforms, or create personalized, timely campaigns. Pipedream's serverless platform connects ConvertKit with hundreds of other apps, enabling automated workflows that save time and improve engagement.

Trigger Code#

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

export default {
  ...common,
  type: "source",
  name: "New Subscriber Activation (Instant)",
  key: "convertkit-new-subscriber-instant",
  description: "Emit new event when a new subscriber is activated. [See docs here](https://developers.convertkit.com/#create-a-webhook)",
  version: "0.0.2",
  props: {
    ...common.props,
  },
  methods: {
    ...common.methods,
    getWebhookEventTypes() {
      return {
        "name": "subscriber.subscriber_activate",
      };
    },
    async processEvent(event) {
      const { body } = event;

      if (!body?.subscriber) {
        return;
      }
      const ts = Date.parse(body.subscriber.created_at);

      this.$emit(body, {
        id: body.subscriber.id,
        summary: `New subscription activation from ${body.subscriber.email_address} created`,
        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
ConvertKit	`convertkit`	`app`	This component uses the ConvertKit 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#

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

All API calls require the api_key parameter. Some API calls require the api_secret parameter. You can find your API Key and Secret in the ConvertKit Account page. See documentation.

About ConvertKit#

Email Marketing for Online Creators

Action#

Create Sales Order on Zoho Books

Description:Creates a sales order.

Version:0.2.1

Key:zoho_books-create-salesorder

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_WYi46K
import { axios } from "@pipedream/platform";

export default {
  key: "zoho_books-create-salesorder",
  name: "Create Sales Order",
  description: "Creates a sales order.",
  version: "0.2.1",
  type: "action",
  props: {
    zoho_books: {
      type: "app",
      app: "zoho_books",
    },
    organization_id: {
      type: "string",
      description: "In Zoho Books, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Books Organization with it's own organization ID, base currency, time zone, language, contacts, reports, etc.\n\nThe parameter `organization_id` should be sent in with every API request to identify the organization.\n\nThe `organization_id` can be obtained from the GET `/organizations` API's JSON response. Alternatively, it can be obtained from the **Manage Organizations** page in the admin console.",
    },
    customer_id: {
      type: "string",
      description: "ID of the customer to whom the sales order has to be created.",
    },
    line_items: {
      type: "any",
      description: "Line items of a sales order.",
      optional: true,
    },
    contact_persons: {
      type: "any",
      description: "Array of contact person(s) for whom sales order has to be sent.",
      optional: true,
    },
    date: {
      type: "string",
      description: "The date, the sales order is created.",
      optional: true,
    },
    shipment_date: {
      type: "string",
      description: "Shipping date of sales order.",
      optional: true,
    },
    custom_fields: {
      type: "any",
      description: "Custom fields for a sales order.",
      optional: true,
    },
    place_of_supply: {
      type: "string",
      description: "Place where the goods/services are supplied to. (If not given, `place of contact` given for the contact will be taken)\nSupported codes for UAE emirates are :\nAbu Dhabi - AB`,\nAjman - `AJ`,\nDubai - `DU`,\nFujairah - `FU`,\nRas al-Khaimah - `RA`,\nSharjah - `SH`,\nUmm al-Quwain - `UM`\nSupported codes for the GCC countries are :\nUnited Arab Emirates - `AE`,\nSaudi Arabia - `SA`,\nBahrain - `BH`,\nKuwait - `KW`,\nOman - `OM`,\nQatar - `QA`.",
      optional: true,
    },
    salesperson_id: {
      type: "string",
      description: "ID of the salesperson.",
      optional: true,
    },
    merchant_id: {
      type: "string",
      description: "ID of the merchant.",
      optional: true,
    },
    gst_treatment: {
      type: "string",
      description: "Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are `business_gst`, `business_none`, `overseas`, `consumer`.",
      optional: true,
    },
    gst_no: {
      type: "string",
      description: "15 digit GST identification number of the customer.",
      optional: true,
    },
    is_inclusive_tax: {
      type: "boolean",
      description: "Used to specify whether the line item rates are inclusive or exclusive of tax.",
      optional: true,
    },
    notes: {
      type: "string",
      description: "Notes for this Sales Order.",
      optional: true,
    },
    terms: {
      type: "string",
      optional: true,
    },
    billing_address_id: {
      type: "string",
      description: "ID of the Billing Address",
      optional: true,
    },
    shipping_address_id: {
      type: "string",
      description: "ID of the Shipping Address.",
      optional: true,
    },
    crm_owner_id: {
      type: "string",
      optional: true,
    },
    crm_custom_reference_id: {
      type: "string",
      optional: true,
    },
    vat_treatment: {
      type: "string",
      description: "Enter vat treatment.",
      optional: true,
    },
    tax_treatment: {
      type: "string",
      description: "VAT treatment for the invoice .Choose whether the contact falls under: `vat_registered`, `vat_not_registered`, `gcc_vat_not_registered`, `gcc_vat_registered`, `non_gcc` , `dz_vat_registered` and `dz_vat_not_registered` supported only for UAE.",
      optional: true,
    },
    salesorder_number: {
      type: "string",
      description: "Mandatory if auto number generation is disabled.",
      optional: true,
    },
    reference_number: {
      type: "string",
      description: "**For Customer Only** : If a contact is assigned to any particular user, that user can manage transactions for the contact",
      optional: true,
    },
    is_update_customer: {
      type: "boolean",
      description: "Boolean to update billing address of customer.",
      optional: true,
    },
    discount: {
      type: "string",
      description: "Discount applied to the sales order. It can be either in % or in amount. e.g. 12.5% or 190.",
      optional: true,
    },
    exchange_rate: {
      type: "string",
      description: "Exchange rate of the currency.",
      optional: true,
    },
    salesperson_name: {
      type: "string",
      description: "Name of the sales person.",
      optional: true,
    },
    notes_default: {
      type: "string",
      description: "Default Notes for the Sales Order",
      optional: true,
    },
    terms_default: {
      type: "string",
      description: "Default Terms of the Sales Order.",
      optional: true,
    },
    tax_id: {
      type: "string",
      description: "Tax ID for the Sales Order.",
      optional: true,
    },
    tax_authority_id: {
      type: "string",
      description: "ID of the tax authority. Tax authority depends on the location of the customer.",
      optional: true,
    },
    tax_exemption_id: {
      type: "string",
      description: "ID of the tax exemption applied.",
      optional: true,
    },
    tax_authority_name: {
      type: "string",
      description: "Tax Authority's name.",
      optional: true,
    },
    tax_exemption_code: {
      type: "string",
      description: "Code of Tax Exemption that is applied.",
      optional: true,
    },
    avatax_exempt_no: {
      type: "string",
      description: "Exemption certificate number of the customer.",
      optional: true,
    },
    avatax_use_code: {
      type: "string",
      description: "Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule.",
      optional: true,
    },
    shipping_charge: {
      type: "string",
      optional: true,
    },
    adjustment: {
      type: "string",
      optional: true,
    },
    delivery_method: {
      type: "string",
      optional: true,
    },
    estimate_id: {
      type: "string",
      description: "ID of the estimate associated with the Sales Order.",
      optional: true,
    },
    is_discount_before_tax: {
      type: "boolean",
      description: "Used to specify how the discount has to applied. Either before or after the calculation of tax.",
      optional: true,
    },
    discount_type: {
      type: "string",
      description: "How the discount is specified. Allowed values are entity_level or item_level. Allowed Values: `entity_level` and `item_level`.",
      optional: true,
    },
    adjustment_description: {
      type: "string",
      optional: true,
    },
    pricebook_id: {
      type: "string",
      optional: true,
    },
    template_id: {
      type: "string",
      description: "ID of the pdf template.",
      optional: true,
    },
    documents: {
      type: "any",
      optional: true,
    },
    zcrm_potential_id: {
      type: "string",
      optional: true,
    },
    zcrm_potential_name: {
      type: "string",
      optional: true,
    },
    ignore_auto_number_generation: {
      type: "string",
      description: "Ignore auto sales order number generation for this sales order. This mandates the sales order number.",
      optional: true,
    },
    can_send_in_mail: {
      type: "string",
      description: "Can the file be sent in mail.",
      optional: true,
    },
    totalFiles: {
      type: "string",
      description: "Total number of files.",
      optional: true,
    },
    doc: {
      type: "string",
      description: "Document that is to be attached",
      optional: true,
    },
  },
  async run({ $ }) {
  //See the API docs: https://www.zoho.com/books/api/v3/#Sales-Order_Create_a_sales_order

    if (!this.organization_id || !this.customer_id || !this.line_items) {
      throw new Error("Must provide organization_id, customer_id, and line_items parameters.");
    }

    return await axios($, {
      method: "post",
      url: `https://books.${this.zoho_books.$auth.base_api_uri}/api/v3/salesorders?organization_id=${this.organization_id}`,
      headers: {
        Authorization: `Zoho-oauthtoken ${this.zoho_books.$auth.oauth_access_token}`,
      },
      data: {
        customer_id: this.customer_id,
        contact_persons: this.contact_persons,
        date: this.date,
        shipment_date: this.shipment_date,
        custom_fields: this.custom_fields,
        place_of_supply: this.place_of_supply,
        salesperson_id: this.salesperson_id,
        merchant_id: this.merchant_id,
        gst_treatment: this.gst_treatment,
        gst_no: this.gst_no,
        is_inclusive_tax: this.is_inclusive_tax,
        line_items: this.line_items,
        notes: this.notes,
        terms: this.terms,
        billing_address_id: this.billing_address_id,
        shipping_address_id: this.shipping_address_id,
        crm_owner_id: this.crm_owner_id,
        crm_custom_reference_id: this.crm_custom_reference_id,
        vat_treatment: this.vat_treatment,
        tax_treatment: this.tax_treatment,
        salesorder_number: this.salesorder_number,
        reference_number: this.reference_number,
        is_update_customer: this.is_update_customer,
        discount: this.discount,
        exchange_rate: this.exchange_rate,
        salesperson_name: this.salesperson_name,
        notes_default: this.notes_default,
        terms_default: this.terms_default,
        tax_id: this.tax_id,
        tax_authority_id: this.tax_authority_id,
        tax_exemption_id: this.tax_exemption_id,
        tax_authority_name: this.tax_authority_name,
        tax_exemption_code: this.tax_exemption_code,
        avatax_exempt_no: this.avatax_exempt_no,
        avatax_use_code: this.avatax_use_code,
        shipping_charge: this.shipping_charge,
        adjustment: this.adjustment,
        delivery_method: this.delivery_method,
        estimate_id: this.estimate_id,
        is_discount_before_tax: this.is_discount_before_tax,
        discount_type: this.discount_type,
        adjustment_description: this.adjustment_description,
        pricebook_id: this.pricebook_id,
        template_id: this.template_id,
        documents: this.documents,
        zcrm_potential_id: this.zcrm_potential_id,
        zcrm_potential_name: this.zcrm_potential_name,
      },
      params: {
        ignore_auto_number_generation: this.ignore_auto_number_generation,
        can_send_in_mail: this.can_send_in_mail,
        totalFiles: this.totalFiles,
        doc: this.doc,
      },
    });
  },
};

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	`zoho_books`	`app`	This component uses the Zoho Books app.
organization_id	`organization_id`	`string`	In Zoho Books, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Books Organization with it's own organization ID, base currency, time zone, language, contacts, reports, etc. The parameter `organization_id` should be sent in with every API request to identify the organization. The `organization_id` can be obtained from the GET `/organizations` API's JSON response. Alternatively, it can be obtained from the Manage Organizations page in the admin console.
customer_id	`customer_id`	`string`	ID of the customer to whom the sales order has to be created.
line_items	`line_items`	`any`	Line items of a sales order.
contact_persons	`contact_persons`	`any`	Array of contact person(s) for whom sales order has to be sent.
date	`date`	`string`	The date, the sales order is created.
shipment_date	`shipment_date`	`string`	Shipping date of sales order.
custom_fields	`custom_fields`	`any`	Custom fields for a sales order.
place_of_supply	`place_of_supply`	`string`	Place where the goods/services are supplied to. (If not given, `place of contact` given for the contact will be taken) Supported codes for UAE emirates are : Abu Dhabi - AB`, Ajman -` AJ`, Dubai -` DU`, Fujairah -` FU`, Ras al-Khaimah -` RA`, Sharjah -` SH`, Umm al-Quwain -` UM`Supported codes for the GCC countries are : United Arab Emirates -`AE`, Saudi Arabia -` SA`, Bahrain -` BH`, Kuwait -` KW`, Oman -` OM`, Qatar -` QA`.
salesperson_id	`salesperson_id`	`string`	ID of the salesperson.
merchant_id	`merchant_id`	`string`	ID of the merchant.
gst_treatment	`gst_treatment`	`string`	Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are `business_gst`, `business_none`, `overseas`, `consumer`.
gst_no	`gst_no`	`string`	15 digit GST identification number of the customer.
is_inclusive_tax	`is_inclusive_tax`	`boolean`	Used to specify whether the line item rates are inclusive or exclusive of tax.
notes	`notes`	`string`	Notes for this Sales Order.
terms	`terms`	`string`
billing_address_id	`billing_address_id`	`string`	ID of the Billing Address
shipping_address_id	`shipping_address_id`	`string`	ID of the Shipping Address.
crm_owner_id	`crm_owner_id`	`string`
crm_custom_reference_id	`crm_custom_reference_id`	`string`
vat_treatment	`vat_treatment`	`string`	Enter vat treatment.
tax_treatment	`tax_treatment`	`string`	VAT treatment for the invoice .Choose whether the contact falls under: `vat_registered`, `vat_not_registered`, `gcc_vat_not_registered`, `gcc_vat_registered`, `non_gcc` , `dz_vat_registered` and `dz_vat_not_registered` supported only for UAE.
salesorder_number	`salesorder_number`	`string`	Mandatory if auto number generation is disabled.
reference_number	`reference_number`	`string`	For Customer Only : If a contact is assigned to any particular user, that user can manage transactions for the contact
is_update_customer	`is_update_customer`	`boolean`	Boolean to update billing address of customer.
discount	`discount`	`string`	Discount applied to the sales order. It can be either in % or in amount. e.g. 12.5% or 190.
exchange_rate	`exchange_rate`	`string`	Exchange rate of the currency.
salesperson_name	`salesperson_name`	`string`	Name of the sales person.
notes_default	`notes_default`	`string`	Default Notes for the Sales Order
terms_default	`terms_default`	`string`	Default Terms of the Sales Order.
tax_id	`tax_id`	`string`	Tax ID for the Sales Order.
tax_authority_id	`tax_authority_id`	`string`	ID of the tax authority. Tax authority depends on the location of the customer.
tax_exemption_id	`tax_exemption_id`	`string`	ID of the tax exemption applied.
tax_authority_name	`tax_authority_name`	`string`	Tax Authority's name.
tax_exemption_code	`tax_exemption_code`	`string`	Code of Tax Exemption that is applied.
avatax_exempt_no	`avatax_exempt_no`	`string`	Exemption certificate number of the customer.
avatax_use_code	`avatax_use_code`	`string`	Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule.
shipping_charge	`shipping_charge`	`string`
adjustment	`adjustment`	`string`
delivery_method	`delivery_method`	`string`
estimate_id	`estimate_id`	`string`	ID of the estimate associated with the Sales Order.
is_discount_before_tax	`is_discount_before_tax`	`boolean`	Used to specify how the discount has to applied. Either before or after the calculation of tax.
discount_type	`discount_type`	`string`	How the discount is specified. Allowed values are entity_level or item_level. Allowed Values: `entity_level` and `item_level`.
adjustment_description	`adjustment_description`	`string`
pricebook_id	`pricebook_id`	`string`
template_id	`template_id`	`string`	ID of the pdf template.
documents	`documents`	`any`
zcrm_potential_id	`zcrm_potential_id`	`string`
zcrm_potential_name	`zcrm_potential_name`	`string`
ignore_auto_number_generation	`ignore_auto_number_generation`	`string`	Ignore auto sales order number generation for this sales order. This mandates the sales order number.
can_send_in_mail	`can_send_in_mail`	`string`	Can the file be sent in mail.
totalFiles	`totalFiles`	`string`	Total number of files.
doc	`doc`	`string`	Document that is to be attached

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