Submitting your Zapier User Documentation

Congratulations on submitting your integration for activation! Before going public, we need a little more information about your integration. We will use this info to create internal and external help documentation.

We will use this information externally for customer-facing help documentation.

We will share all information internally with our Support team. If needed, they can use it to help customers troubleshoot their Zaps.

Submit plain, unformatted text. Our team will adjust style and layout for you.

Your contact info is not shared with customers.

If you have questions about this form, contact Zapier's Partnerships team: partners@zapier.com.

Note: This form will take a 10-15 minutes to complete.

Provide instructions for finding the API key in your platform, as well as information about any other required or optional fields and how to find them.

• Enter each step on a new line.
• Don't include any steps related to using Zapier.
• Don't include any formatting like bullet points, numbers, bold or italic font.

Example:
Log into your APP account.
Click Settings from the top menu.
Select API.
Click Generate API key.
Copy the API key to your clipboard.

 

Provide instructions for using session authentication in your platform, as well as information about any other required or optional fields and how to find them.

• Enter each step on a new line.
• Don't include any steps related to using Zapier.
• Don't include any formatting like bullet points, numbers, bold or italic font.

Example:
Log into your APP account.
Click Settings from the top menu.
Select XYZ.
Click Do this.
Copy the Thing to your clipboard.

 

1. Does your integration support self-hosted accounts, cloud-hosted accounts, or both?

• Self-hosted accounts are user accounts stored on the user's own server.
• Cloud-hosted accounts are user accounts stored on your platform's servers.

2. Do users need a paid account with your platform to use this Zapier integration?

3. Do users need special account permissions in your platform to use this Zapier integration?

• General account permissions
  • Are certain users restricted from using Zapier?
  • Example: "Only admins can use this integration."
• Endpoint- or role-specific permissions
  • Are certain users restricted from using specific triggers or actions?
  • For example, "Only admins and owners can create a contact but all users can find a contact."

4. Are there any usage limits that affect this integration?

• Examples:
  • Rate limits
  • API token limits
  • Webhook limits

5. Are there any pagination limits that affect this integration?

• Are there limits on the number of results returned per poll or GET request?

6. Do your triggers use real sample data or generic sample data?

• Can users load real data from their account as a trigger sample?
• Or does the app only provide default data like "Jane Doe", "jane@example.com", and "(555) 555-5555" as sample data?

7. Does your integration support custom fields?

• If a user creates a custom field in your platform, is it visible in your Zapier integration?

8. If your integration includes actions that update the data in existing fields/data in your platform, does your integration overwrite or append to existing data? 

• Overwrite: new data replaces existing data
• Append: new data is added to existing data

9. Do you need to provide any additional info about your integration?

• Examples:
  • Other restrictions
  • Common problems
  • Other help docs on your platform