The Integration View is designed to give detailed information on the status of the integrations created against a Flow by your end-users. It also provides visibility of all events taking place inside an integration. Using this, you get the means to debug integrations, check the tasks being consumed by an end-user or an integration, or see if every step of the Flow is performing as intended.
To open the integration view, go to the Flows tab in your dashboard and hover over the stats of any Flow. You will be able to see the "View Integrations" tooltip, shown above.
You can also click on the menu button of the Flow and click on All Integrations to view all the current integrations made against a Flow.
If no integrations have been created against a Flow, you will see a "No integrations to see" tooltip on hover, and the stats will not be clickable.
Integration Detail Page
As you'll click on a Flow's Integration stats icon, you will be taken to the Integration Detail Page.
At the top of this page, you'll see the Flow Name, Flow ID, and Flow Status. The Status could either be Published or Draft, depending upon the current state of the Flow.
Next, you'll see a search bar where you can search for an integration by Integration ID, User ID, or User Auth. To search for the required integration, please enter the complete IDs.
Next, you'll see a table with the following information segregated in columns.
- Integration ID - The unique ID of an integration assigned by Integry.
- User ID - This is a unique ID assigned to an end-user by your (or a third-party) app.
- User Auth - This is the ID the end-user used to sign into your application.
- Date Created - The date and time of an integration created. You can click on the arrows to sort the list of integrations from newest to oldest or vice versa.
- Last Run Start - The last time when the integration’s run get executed.
- Last Run Status - This is the status of the last step in the integration. It has the following states:
- OK - Integration ran successfully
- Failed - Failure in a step occurred
- Running - A run is being executed
- Hasn't Run - The integration hasn't been initiated yet
- Integration Status - The current state of an integration:
- Initializing - The trigger is received and the integration is launching
- Enabled - A trigger can be received for this integration
- Disabled - A trigger cannot be received for this integration
- Paused - The integration has been halted because too many errors have occurred or due to a billing issue
- Failed to Initialize - The integration could not be launched
- Deleted - The integration has been deleted. Once deleted, an integration cannot be re-enabled. Therefore, it's advised to disable your end-users' integrations before permanently deleting them
- View - When you click this button, you will be taken to the Run Detail Page where you can view all the runs executed for an integration.
To delete or disable an integration, click on the meatballs menu.
Filtering Integrations
You can filter the list of integrations on the Integration detail page. Before applying a filter, your integrations will be viewed as 10 integrations per page by default.
You can change the integration view per page, shown above.
To apply a filter to your integrations list, click the Filter button, shown above.
How to Diagnose an Integration Error?
If the integration is running smoothly, you can track end-user activity by viewing the runs, steps, data requests, and payload received at every step.
That also means that you can easily diagnose an error that occurs at any step in your integration.
Click on the View button of a faulty integration.
You can also apply a filter to list down faulty integrations (shown above) so you can go over them one-by-one.
Run Detail Page
On this page, you will find all the runs executed for your integration.
At the top, you'll see Flow and integration details and then a list of all the runs executed for this particular integration. For each run, the following information is displayed in the Runs table.
- Run ID - The unique ID assigned to each run of an integration.
- Trigger App - The application that initiates the run and launches an integration.
- Trigger Name - The name of the Trigger configured in the App Connector.
- Trigger Type - Trigger type configured in the App Connector, e.g., Webhook or poll-based.
- Start Time - When the run initiates.
- Duration - The amount of time it takes to complete an execution of a run.
- Status - This shows if the run executed successfully or not.
- Network Code - This is the HTTP response status code for the last step of a run, e.g., 200, 404, 500, etc. See a complete list here.
You can also search for a run by entering its ID or Trigger App.
You can also shortlist Runs based on their Start Time, Run Status, and Network Code. Click on Apply to apply the filter.
For every Run, you can click on the meatballs menu to copy the link of the Run and share `
To view the error log, click the View GCP Logs Explorer.
You can click on the View button (shown above) to see the steps of the Flow that failed to execute as intended.
Step Detail Page
As you know, your Flows are built up using different steps. An error could occur at any of these steps and cause your integration to stop working. You can find out which step failed for an integration run by viewing the Step Detail Page.
At the top, you'll find the information about the integration and the run the steps belong to. Then you'll see the following information for the steps of the chosen Run.
- Step ID - The unique ID of the step.
- Step App - The app being used in the step.
- Step Name - The name of the step.
- Start Time - The time when the step was executed.
- Duration - The amount of time the step took to execute.
- Step Status - This indicates whether the step was executed successfully or not.
- Network Code - The HTTP response status code for the step.
- View Payload - Click on this button to view the payload of the API Call made at the chosen step.
You can see the following sections upon viewing the payload of a selected step. By default, the response section is selected in the payload view because that's how you'll know about the error.
Request - View the request URL, headers, and body of the API request made for a step.
Response - View the headers and body (raw and parsed) of the API response received for a step.
Object - An object is a key-value pair created by Integry to store data in a recognizable way. For example, an email could be saved as a key-value pair which can later be fetched for different purposes.
By default, the response section opens up when the payload is viewed. You can diagnose the error in the response section, shown above.
If your end-users report an issue with your live integrations, you can debug the errors by checking where the integration failed. However, if you can't resolve the issue, you can copy the error response (shown above) with our customer support team and we'll resolve it for you.
If you want to debug the error yourself, click on the link (shown above) to visit the API and error documentation of the application. You can understand the error type and the reason behind the occurrence of an error.
Enable Error Notifications for End-User Integrations
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.
Click on the link shown in the image to set up error notifications for integrations.
Comments
0 comments
Please sign in to leave a comment.