Articles in this section

Monitor flows and APIs in an integration

Kathyana Queeman
Updated

The Flows, APIs, and tools tabs allow you to manage all the flows, tools, and APIs registered to a particular integration.

Use the Flows tab to review your flows’ status, monitor your errors, edit your mappings, add an import, and run your flow, among other features. If it’s empty, you haven’t created any flows in your integration. Remember, this tab displays data for the current integration’s flows, not for every flow you’ve ever created.

In the APIs tab, you can create and organize APIs created using the API builder. You can add, delete, and modify any API registered to your integration. Support for the following API features will be added at a later date:

  • Creating and managing JavaScript APIs.

  • Revisions and other Integration Lifecycle Management (ILM) features.

  • Managing API tokens from an integration.

  • Viewing API analytics and dashboards.

  • API error notifications.

  • Custom settings in APIs (JSON settings field).

  • Aliases for APIs.

In the Tools tab, you can create and organize tools created using the Tool builder. You can add, delete, and modify tools registered to your integration. The following tool features and limitations apply:

  • Tools support agents and MCP servers only.

  • Currently, the tool import step is not supported in flows.

  • The following capabilities are not supported for tools:

    • ILM (Integration Lifecycle Management)

    • Cloning

    • Download

    • Upload

    • Debug logs

  • If a tool is referenced in a flow or integration, that flow or integration cannot be cloned, downloaded, or included in ILM.

Review your flow, API, or tool details

7232140731419-Integration_flows_tab.png

Flows, APIs, and Tools

At the most basic level, these tabs give you a quick overview of your flow or API status. You can also search for, sort, and create flows and APIs in your integration here.

In the Flows tab, you can use + Load data to import data files into NetSuite, Salesforce, or any other RESTful web application. In Data Loader, you can upload files, configure settings, map fields, and run an import.

In the APIs tab, you can create and manage any APIs registered to your integration.

In the Tools tab, you can create and manage any tools registered to your integration.

In the More menu, you can attach a new flow, API, or tool to the integration and organize your flows, APIs, and tools into groups.

Dates and Times

Verify when your flow, API, or tool was last updated and when it last ran using the Last updated and Last run columns. These dates are in your account’s selected Date and Time format. If you’ve opted to show your timestamps as relative, it displays the amount of time elapsed since an event occurred, like 1 hour ago or 1 day ago.

Manage your flows

Aside from viewing details, you can manage your flows or APIs by changing your mappings, debugging, scheduling, and otherwise modifying them.

The Mapping icon (lego.svg) displays all the import mappings for a flow. It includes flows with multiple import mapping steps; for example, a flow that imports return authorizations to NetSuite and then imports return authorization item receipts. When you click your import, the mapping appears with all its functionality, including reviewing your Input, Output, Preview, or Auto preview.

You can Schedule your flow to run in any time zone and frequency. The Frequency and Type determine how often you want your flow to run. There are preset values ranging from minutes to weeks, or you can use cron scheduling for more control over when your flow runs and at what intervals.

Click Run now to run a flow regardless of when it was scheduled. This button is helpful when you’re debugging your flow or fixing mappings.

Turn on an individual flow using the On/Off button so the flow runs at its scheduled time. This is useful if you want to test your changes, but don’t want to run your flow unnecessarily. Remember, you can always turn an individual flow on or off; you don’t need to stop your entire integration to deal with one error or reschedule one flow.

You can perform other actions on your flow using the Actions overflow menu in the rightmost column.

15362598093083-mceclip0.png

  • Edit flow: takes you into your flow for more detailed editing.

  • View audit log: retrieves audit logs for your individual flow. You can find integration-wide audit logs at the top menu.

  • Used by: shows you if your flows or resources are being used elsewhere. Check these references before you decide to delete a flow to make sure you’re not permanently deleting it from multiple integrations.

  • Download flow: you can download a specific flow as a ZIP file to send it to another user, install it, and/or duplicate it in a different account. When uploaded, the flow becomes installed as part of a new integration.

  • Clone flow: clones an individual flow into the same or a different integration or a Production or Sandbox environment.

  • Detach flow: detaches a flow from its integration, becoming a standalone flow that you can attach to another integration. This feature removes the flow from your integration.

  • Delete flow: deletes a flow from your integration permanently, unless you’ve cloned or downloaded the flow.

Errors (flow only)

Scan this column to determine if your flows have errors. When you click the Success or Error(s) status, you can see your source and destination applications, their configurations, and which part of the flow was affected.

7232150356251-Errors_highlighted.png

Click on your Success or Error(s) button to open your flow’s error configurations

7232202684699-Successful_flows.png

Successful flow

7232224045851-Unsuccessful_flow.png

Unsuccessful flow with one error

Click the error to view the full message, error code, the source, classification, timestamp, and the actions you can take to resolve it. You can search for, resolve, retry, refresh, or download one or more errors from this page.

7232227022747-Error_message.png

Pop-up error

The Message gives you the reason for your error. In this example, a value wasn’t generated because you can’t use a regexMatch to find a specific filename.

The Code determines the type of error. Search for this code to help you narrow down solutions – in this Help Center, in your API guide, or with the help of our community.

The Source filter tells you where your error originated. Narrow this down to any area of your flow.

The Classification filter categorizes errors automatically according to their properties, like code, message, and source fields. For more information, see Error classifications. Classifications include:

  • all classifications

  • connection

  • duplicate

  • governance

  • intermittent

  • missing

  • parse

  • value

Filter your Timestamp to search for every instance that the error occurred in. Either today, yesterday, in the past 24 hours, 7 days, 15 days, 30 days, or a custom timeframe.

You can take several Actions when you’re dealing with an error. These vary depending on the type of error. Some example actions are:

  • Edit retry data: allows you to edit how your data is imported

  • Resolve: categorizes the error as fixed, regardless of any edits or updates, and removed from the queue. You can resolve an error that you haven’t already fixed, but it may reoccur when you run your flow again.

  • Retry: retry your error.

  • View error details: a breakdown of the error and the trace key.

  • Additional actions based on the type of flow: you may see additional actions that are based on the type of connection you’re using. Here’s an example:

    • HTTP connection:

      • View HTTP request: displays the HTTP request you sent to your application

      • View HTTP response: displays the HTTP response your application sent (the complete context for the Message).

Manage your APIs

Maintaining an API after it's been created is very straightforward.

  • Name: The name you gave your API when you created it.

  • Version: The version you gave your API when you created it. This can be changed in the API's settings in the API builder. The version is included in the API's URI as follows: https://api.integrator.io/apis/<version>.

  • HTTP method: The HTTP method you chose when you created your API request.

  • Relative URI: The relative URI you created when configuring your API request. This is relative to https://api.integrator.io/apis/<version>. Query parameters are excluded in this view.

    The API endpoint URL is publicly accessible and may be identical to an existing one in a different account. However, only users with a valid API token can successfully invoke it, ensuring secure access for the intended audience. The endpoint URL must be unique within your account – meaning that you can't have two identical endpoint URLs enabled simultaneously in the same account.

  • Last updated: The date and time your API was last updated.

  • Actions overflow (...): Additional options for managing your API. These are available for every API.

    • Edit API: Click this to open the API builder and edit your API as needed.

      Tip

      Alternatively, you can edit your API by clicking its name.

    • View request logs: View and manage your request logs.

    • View audit logs: View and manage your API's audit logs.

    • Push to APIM or View in APIM (API Management only): Push your API to your API console so you can add additional configurations and publish your APIs. If you've already pushed the API, an APIM label will appear next to the API on the API builder list page.

    • Download OpenAPI spec: Download the OpenAPI spec automatically generated by the Celigo platform.

    • Download API: Download your API.

    • Copy cURL: Copy a cURL command to invoke your API. For example:

      curl -X GET "https://api.integrator.io/apis/v1/pets/sampleid?microchip_id=true" \
-H "Authorization: Bearer ********"

      Warning

      The cURL command is only available after you configure your API request.

    • Add to MCP server: Learn more about MCP servers.

    • Clone API: Create a clone of your API.

    • Move to integration: Move your API to another integration.

    • Delete API: Delete your API. The API is sent to the Recycle bin for 30 days or until your data retention policy purges it.

    • Used by: Any resources using or used by the API.

    • Disable API (not pictured): You can disable the API to stop access to the API, for example, while testing or retiring the API.

      Warning

      Disabling an API may affect existing users who are reliant on that service.

    APi_list_actions_.png

    Actions overflow menu in the API builder list view

Manage your tools

Maintaining a tool after it's been created is very straightforward.

  • Name: The name you gave your tool when you created it.

  • Last updated: The date and time your tool was last updated.

  • Actions overflow (...): Additional options for managing your tool. These are available for every tool.

    • Edit tool: Click this to open the Tool builder and edit your tool as needed.

      Tip

      Alternatively, you can edit your tool by clicking its name.

    • View audit logs: View and manage your tool’s audit logs.

    • Used by: Any resources using or used by the tool.

    • Delete tool: Delete your tool. The tool is sent to the Recycle bin for 30 days or until your data retention policy purges it.

    tools_action_menu_in_integration.png