Response types Zapier expects

Method	Response type	Notes
Authentication	Object	Single JSON-formatted object with any specific fields for auth scheme.
Authentication testing	Object	Object
Trigger	Array	JSON-formatted array with the results in reverse chronological order. Results are parsed and passed through deduplication. Empty arrays will not trigger.
Create action	Object	Individual fields within object are parsed for mapping into subsequent Zap steps.
Search action	Array	JSON-formatted array sorted with the best match first, but don’t limit to a single result or group them as one. For no match found, return a `200` with an empty array.

Method

Response type

Notes

Authentication

Object

Single JSON-formatted object with any specific fields for auth scheme.

Authentication testing

Object

Trigger

Array

JSON-formatted array with the results in reverse chronological order. Results are parsed and passed through deduplication. Empty arrays will not trigger.

Create action

Object

Individual fields within object are parsed for mapping into subsequent Zap steps.

Search action

Array

JSON-formatted array sorted with the best match first, but don’t limit to a single result or group them as one. For no match found, return a 200 with an empty array.

Note:

If your app’s API call does not return a response, Zapier will show a timeout error.
If you use line items in your integration, note that not all Zapier integrations support line items. Use the recommended response type in the table to reduce users possibility of needing to reformat this data to use in their Zap workflows. Learn more on how line items work in Zap workflows.

Return related data as line items

Line items are used to present multiple items associated with a single transaction, such as an order or an invoice. To return line items in the data for your users in actions, you’ll need to return the multiple items you want to show as an array of objects under a descriptive key.

For example, a Create Order action returning an order with multiple items might look like this:

order = {
  name: "Zap Zaplar",
  total_cost: 25.96,
  items: [
    {
      name: "Zapier T-Shirt",
      unit_price: 11.99,
      quantity: 3,
      line_amount: 35.97,
      category: "shirts",
    },
    {
      name: "Orange Widget",
      unit_price: 7.99,
      quantity: 10,
      line_amount: 79.9,
      category: "widgets",
    },
    {
      name: "Stuff",
      unit_price: 2.99,
      quantity: 7,
      line_amount: 20.93,
      category: "stuff",
    },
    {
      name: "Allbird Shoes",
      unit_price: 2.99,
      quantity: 7,
      line_amount: 20.93,
      category: "shoes",
    },
  ],
  zip: 01002,
};

Return multiple items as search results

Do not use line items to group search results. Although Zap workflows only use the first result by default, users can decide to group all results as line items. Other products, like Agents, will always use all results. Do not group multiple results into line items — let products and users control that instead.

Quick start

Build with UI

Build with CLI

Manage

Publish

Embed

Reference

Response types Zapier expects

Return multiple items as search results

​Return related data as line items

​Return multiple items as search results

Return related data as line items

Return multiple items as search results