Anytime an error occurs in one of your end-user integrations, you could get notified about that error. You can open the link in the notification message to analyze the failed integration in the Integration View. That way, you can look into the failed step of a particular integration run and diagnose the issue. Fix the issue either by yourself or get in touch with our team to fix your integration errors.
In this article, you're going to learn how to set up error notifications for the end-user integrations created against your flows.
Click on your profile to open a menu and go to your Account Settings.
Click on Error Notifications tab from the left-side menu.
Here, you can see the following three sections.
- Send to an app - You can configure your Zendesk and Slack accounts to send error notifications to any or both of these apps.
- Send to a URL - You can send error notifications on a webhook URL.
- Settings - You can do error notification settings in this section.
We'll discuss each of these sections in detail below.
Send to an app
When an error occurs in an end-user integration, you could get notified about it via:
- A message posted to a Slack channel
- A ticket created in Zendesk
Post Message to Slack
To setup error notifications for Slack, click on the first option.
A modal window will open up where you'll be asked to add your Slack account.
Authenticate your Slack account by allowing Integry to access your Slack workspace.
After your account is successfully connected, you can click Next to proceed.
Next, you'll be asked to configure Slack. Select the channel where you want to post a message when an error occurs in an integration.
Once the configuration is complete, you'll see the message shown above. Click Save to complete the error notification to Slack set up.
Click OK to receive an example message on your chosen Slack channel.
You'll see an error message notification on your Slack channel. As shown above, you can see the following parameters in the error notification message.
- Network Code - This is a three-digit code for server's response. See the complete list here.
- Response - The response message sent by the request server
- Run ID - The unique ID of the an integration execution run
- Flow - The name of the Flow for which the integration gets executed
- User ID - The unique ID of the end-user who executed the integration
- User Auth - The ID used by the end-user to sign into your app
- Integration ID - The unique ID of every end-user integration
- Error Details - This URL takes you to the specific step of the integration run where the error occurred.
How to Customize Error Notification?
You can customize the error notification message for your flows. The standard error message contains the parameters listed above. However, you can add more parameters to your error message the following way.
In the Flow builder, open a flow for which you want to customize the error message. Then click on the Error Handling icon in the side menu, shown above.
This is the standard error message that you will receive upon the occurrence of an error. If you want to add more data to it, click on the '+' icon to add more tags.
You can add any additional data here using tags. In this example, we've added a spreadsheet ID and email ID to the error message.
You can see the additional information (highlighted above) is appended to the standard error message received on Slack.
Creating a Ticket in Zendesk
To create a ticket in Zendesk, click on the relevant option.
A modal window will show up, where you will be asked to connect your Zendesk support account. Click on the button to connect your account, shown above.
Read the instructions carefully and enter the required information in the given fields.
In your Zendesk Account, click on Zendesk Products to open the products menu and click on Admin Center, shown above.
From the side panel, click on Apps and Integrations to expand the menu and select Zendesk API under the APIs heading, shown above.
Enable the Password access option in the settings. Enabling this option will let Integry access your Zendesk Support account on your behalf.
After Connecting your Zendesk Support account, it will be listed and selected, shown above. Click Next to proceed.
In the next step, configure Zendesk by filling the following information in the form.
- Status - Select the status of the ticket that is to be created as you receive an error notification.
- Type - Select the type of the ticket. For example, question, task, problem or an incident.
- Priority - Select the priority of the ticket.
- Assignee - Select the Assignee of the ticket.
- Group - Select the group where the ticket would belong.
- Tag - Select the tag that is to be attached to the ticket.
Once you're done configuring, click on Next to continue.
After successfully setting up error notifications for Zendesk, click on Save.
A modal window will show the success message and notify you that a sample ticket will be created in your Zendesk support account. Click Ok to continue.
Go to your Zendesk Support account and you'll see a sample ticket created in your account.
In the Manage tab, you can see all the error notification setups. You can view and manage the following:
- Runs - Total number of tickets created in your Zendesk support account or total number of messages sent to your Slack channel.
- Last execution at - The last time this setup ran.
- Refresh - Refresh the integration to load the correct data.
- Enable/disable - Toggle on to enable and toggle off to disable notifications.
- Edit/Delete - If you want to connect a different Zendesk account or edit the configuration, click on the kebab menu to edit or delete the error notification setup.
Send to a URL
You can also configure error notifications for any third-party URL. Whenever an error occurs in one of your end-user integrations, a notification can be received at this URL.
Note: Please enter a webhook URL in order to receive the error message payload via Integry.
Enter the URL in the textfield and click Save. An error notification will be sent to the specified URL.
If an end-user integration contains recursive functions or loops and the integration fails, chances are that the same error notification will be generated multiple times. To avoid receiving the same error notification again and again, you can handle throttling errors in this section.
You can mute recurring notifications and enable them only once at your selected time period.
Please sign in to leave a comment.