Errors from your API cause pain for users at two vital points:
message
included in the response details an error, users should never receive a success/200 response if there was an error in the request as this will not show up as an error in the Zap history.
If 95% of a Zap’s runs in the last 7 days are assigned the “Stopped / Errored” status, the Zap will be automatically turned off. The Zap will not run again until the user manually enables it, so only return an error if the scenario is truly an error that needs to be fixed.
Monitor spikes in errors from the the Monitoring page in the Platform UI as leading indicators of problems users are facing within your integration.
The more descriptive and thorough error handling your API and integration have in place, the easier it will be for users to resolve their own issues and for Zapier’s support team to assist with debugging.
If you don’t have control to make changes to the API itself, utilize custom error handling to improve your error messages:
throw new z.errors.Error('Contact name exceeds character limit.', 'InvalidData', 400);
skipThrowForStatus
is set from the Advanced tab. This allows for custom error handling for status codes above 400. Note that 401 status codes will throw a RefreshAuthError
regardless.