Best answer

Trigger design best practices

  • 31 May 2023
  • 1 reply

We are writing our first Zapier integration and I have a question about how best to structure triggers that we expose.

Our system is similar to a CRM and looking at for example Hubspot triggers, they have a “New Contact” event _an_ a combined “Contact Create or Updated” event. Whereas we were planning on having separate “Created” and “Updated” events for our entities.

A common scenario for our customers would be syning contacts from our system to another.

Before we publish our V1, would there be any reason to favor one approach over the other? Any lessons learned from experience?

And is there a best practices guide for designing triggers that covers decisions like this?



Best answer by MarinaH 14 June 2023, 22:20

View original

This post has been closed for comments. Please create a new post if you need help or have a question about this topic.

1 reply

Userlevel 4
Badge +9

Hi @bc_andrew  👋

Great questions and thanks for considering our mutual users’ experience as you build your first Zapier integration 🎉

There is some guidance on building triggers for a CRM app here: 

Generally, it is good practice to have separate triggers for New and Updated items - as this allows your users to build Zaps for only new items (without adding a Filter step, which they would need to if there was a single trigger for a New or Updated Item) if they wish.

However, that also depends on the number of trigger items your app has - as too many triggers to choose from can be overwhelming for users as well - for example if you have multiple events that you’ll be offering a New or Updated trigger for. 

I can’t speak to the exact reason for HubSpot app choosing to have one New or Updated Item trigger, but that could be a factor (limiting total number of triggers to build/maintain/have users select from).

An opposing view would also be that a certain user may prefer a single trigger for a new or updated item, if they wish to perform the same action on those items - as they can then build just the one Zap for their workflow. But with easy functionality to duplicate Zaps, it is not overly burdensome for users to create another Zap with the same action and a different trigger.

It really depends on which event in your app you’re building the trigger for, and how you see our mutual users using it. Since you’re planning to have separate “Created” and “Updated” events for your app’s events, there is definitely no recommendation not to do it that way 👍

If you haven’t already, you’ll want to check out these integration review guidelines when you’re ready to submit your app for Publishing review. You can also choose to keep your app Private, with the differences described here.