Articles in this section

Monitor flows, APIs, tools, and topics in an integration

The Flows, APIs, Tools, and Topics tabs let you manage all the flows, APIs, tools, and topics registered to a particular integration. This article describes what you can see and do on each of these tabs.

Use the Flows tab to review your flows’ status, monitor your errors, edit your mappings, add an import, and run your flow. 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.

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.

In the Topics tab, you can create topics, register existing topics, and view each topic's message history.

Review your flow, API, tool, or topic details

These tabs give you a quick overview of your flows, APIs, tools, and topics. You can also search for, sort, and create them here.

In the Flows tab, you can use Create > Data loader flow 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 Topics tab, you can create and manage any topics registered to your integration.

In the Actions menu, you can move a flow, API, or tool to the integration and organize your flows and API 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 timestamps as relative, it displays how much time has elapsed since an event occurred, like 1 hour ago or 1 day ago.

Manage your flows

Beyond viewing details, you can manage your flows by changing mappings, debugging, scheduling, and other modifications. Select Create to add a flow to this integration.

Column What it shows
Name/Description The flow's name and description. Select the name to open the flow.
Errors Whether the flow has errors. Select Success or Error(s) to open the flow's errors. See Errors (flow only).
Last updated When the flow was last changed.
Last run When the flow last ran.
Mapping (lego.svg) All the import mappings for the flow, including flows with multiple import steps. Select an import to open its mapping, including Input, Output, Preview, or Auto preview.
Schedule Schedule your flow to run in any time zone and frequency. Use the preset values, which range from minutes to weeks, or cron scheduling for more control. Flows that run in real time, including flows that listen to a topic, show Realtime instead.
Run Runs the flow now, regardless of its schedule. This is useful when you're debugging your flow or fixing mappings.
Enabled Turns the flow on so it runs at its scheduled time, or off so it doesn't run. You can turn an individual flow on or off without stopping your entire integration.

Flows that listen to a topic run whenever messages are published to the topic, so you can't schedule them or run them manually. Turning the flow off pauses its subscription. When you turn the flow back on, it processes the messages published while it was off, as long as they're still within the topic's retention period. See Subscribe a flow to a topic.

Action What it does
Edit flow Opens the flow for more detailed editing.
View audit log Shows the audit log for this flow. Integration-wide audit logs are on the integration's Audit log tab.
Used by Shows whether the flow or its resources are used elsewhere. Check these references before you delete a flow so you don't remove it from other integrations that use it.
Clone flow Clones the flow into the same or a different integration, or into another environment.
Download flow Downloads the flow as a ZIP file that you can send to another user, install, or duplicate in a different account. When uploaded, the flow is installed as part of a new integration.
Move flow Detaches the flow from this integration so you can attach it to another integration.
Delete flow Deletes the flow and sends it to the Recycle bin for your data retention period.

Errors (flow only)

Scan this column to determine if your flows have errors. When you select 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

Select your Success or Error(s) status to open your flow’s error configurations

7232202684699-Successful_flows.png

Successful flow

7232224045851-Unsuccessful_flow.png

Unsuccessful flow with one error

Select 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 in Celigo Connective.

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: lets you edit how your data is imported.
  • Resolve: marks the error as fixed and removes it from the queue, regardless of any edits or updates. 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).

Note: For a flow that listens to a topic, a failed record stays retryable from its retry data even after the original message ages out of the topic.

Manage your APIs

The APIs tab lists the APIs registered to your integration.

Column What it shows
Name The name you gave your API when you created it.
Version The version you gave your API. You can change it in the API's settings in the API builder. The version is part of the API's URI: 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, relative to https://api.integrator.io/apis/<version>. Query parameters aren't shown.
Last updated When the API was last changed.

Note: The API endpoint URL is publicly accessible and may match an endpoint in a different account, but only users with a valid API token can invoke it. The endpoint URL must be unique within your account. You can't have two identical endpoint URLs enabled at the same time.

Action What it does
Edit API Opens the API builder so you can edit the API. You can also select the API's 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 to add configurations and publish it. An APIM label appears next to pushed APIs.
Download OpenAPI spec Download the OpenAPI spec that the Celigo platform generates.
Download API Downloads your API.
Copy cURL Copies a cURL command that invokes your API. See the example after this table.
Add to MCP server Adds the API to an MCP server. See Create MCP servers.
Clone API Creates a clone of your API.
Move to integration Moves your API to another integration.
Delete API Deletes your API and sends it to the Recycle bin for your data retention period.
Used by Shows any resources that use or are used by the API.
Disable API Stops access to the API, for example while you test or retire it. Disabling an API may affect users who rely on it.

Example cURL command:

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

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

APi_list_actions_.png

Actions overflow menu in the API builder list view

Manage your tools

The Tools tab lists the tools registered to your integration.

Column What it shows
Name The name you gave your tool when you created it.
Last updated When the tool was last changed.
Action What it does
Edit tool Opens the Tool builder so you can edit the tool. You can also select the tool's name.
View audit logs View and manage your tool's audit logs.
Used by Shows any resources that use or are used by the tool.
Delete tool Deletes your tool and sends it to the Recycle bin for your data retention period.
tools_action_menu_in_integration.png

Manage your topics

The Topics tab lists the topics registered to your integration. Select Create topic to create one, or Register existing to add a topic that's already in your account. A topic also registers automatically when you select it in a flow step and save the step.

Column What it shows
Name/Description The topic's name and description. Select the name to edit the topic.
Last updated When the topic was last changed.
Retention How long the topic keeps each message. Messages are deleted after this period, whether or not they've been read.
View messages Opens Message history, where you can filter and view messages or select Purge messages to delete all of them. You can't undo a purge. See View and purge a topic's message history.
Action What it does
Edit topic Change the topic's name, description, or retention period. See Create and manage topics.
View audit log View changes made to the topic.
Used by See the flows that publish to or listen to the topic.
Deregister Remove the topic from this integration without deleting it. You can't deregister a topic while a flow in this integration uses it. See Grant access to topics.