Ctrlk
Sprinto DashboardAPI Reference

Get Started with Ingestion in Sprinto

Learn how to get started with Ingestion in Sprinto using AI-assisted workflows to connect external systems, process incoming data, and review ingested records.

Sprinto’s Ingestion module helps you connect external systems and bring their data into Sprinto for processing, monitoring, and automation.

Most workflows can be built directly using the AI Editor. Instead of manually configuring every workflow step, you can describe what you want in plain language and let Sprinto generate the ingestion workflow for you.

You can use Ingestion to:

  • Connect external systems and APIs

  • Process incoming data and events

  • Create custom ingestion workflows

  • Store records as entities

  • Monitor and troubleshoot ingestion activity

Before You Begin

Ensure that:

  • You have access to the Ingestion module

  • API keys or credentials for the external system are available

  • You know which system or workflow you want to connect

Step 1: Create an Ingestion Plan

To create a plan:

  1. Log in to the Sprinto dashboard.

  2. Go to Ingestion.

  3. Open the Plans tab.

  4. Click New Plan.

You can create a plan using either of the following options:

Option
Description

From Template

Uses a preconfigured ingestion workflow provided by Sprinto

From Scratch

Creates a fully custom ingestion workflow

Create a Plan from a Template

Template-based plans are recommended for most users because they already include the workflow structure required for supported integrations.

Use a Template

  1. Click New Plan.

  2. Select From Template.

  1. Browse the available templates.

  2. Click Preview on the required template.

  1. Review:

    1. Integration details

    2. Required credentials

    3. Available checks

    4. Included configuration

  2. Click Use This Template.

Sprinto creates the ingestion plan using the selected template.

After the plan is created, Sprinto opens the plan overview drawer.

Configure the Workflow

After the template is created, review and configure the workflow settings.

You can configure:

  • Parameters

  • Credentials

  • Providers

  • Sync settings

  • Execution steps

Configure Parameters

Some templates require parameters before they can sync successfully.

To configure parameters:

  1. Locate the Parameters section.

  2. Click Edit.

  3. Enter the required values.

  4. Click Save.

Parameters help the workflow retrieve the correct data from the external system.

Connect Credentials

Templates often require authentication before data can sync successfully.

You can either:

  • Attach an existing credential

  • Create a new credential connection

Use an Existing Credential

  1. In the Credentials section, click Add Existing.

  2. Select the required credential.

  3. Click Attach.

Create a New Credential

  1. Click Connect next to the required credential.

  2. Enter the required authentication details.

  3. Save the connection.

Depending on the integration, authentication may require:

  • API keys

  • Tokens

  • OAuth credentials

  • Secret values

Use AI Editor to Modify the Workflow

Once the workflow is connected, you can open the AI Editor to customise or extend the ingestion logic.

To open AI Editor:

  1. Open the three-dot menu next to the plan.

  2. Click AI Editor.

The AI Editor allows you to modify workflows using natural language prompts.

Instead of manually editing workflow steps, you can describe the changes you want Sprinto to make.

Example prompts:

The AI Editor can help generate or modify:

  • Workflow steps

  • Entity mappings

  • Parameters

  • Providers

  • Checks

  • Processing logic

Review Execution Steps

The Execution Steps section displays all workflow steps included in the ingestion plan.

This helps you understand:

  • What actions are executed

  • How data is processed

  • Which steps are included in the workflow

You can review the execution flow before running the plan.

Click Execute to execute the steps.

Run the Workflow

After configuration is complete:

  1. Open the plan overview page.

  2. Click Run to execute the workflow immediately.

  1. Enter the required parameters.

  2. Select the Disable cache and Verbose logging check box if needed.

  3. Click Run Plan.

Sprinto begins processing the configured ingestion steps.

Troubleshoot the Workflow

If the workflow encounters issues, use the Troubleshoot option.

Troubleshooting allows you to:

  • Provide parameter values

  • Run the workflow in debug mode

  • Disable cache

  • Commit data during debugging

  • Test full or partial execution

Review Run History

Use the History option to review previous executions.

Run history helps you monitor:

  • Execution status

  • Workflow duration

  • Processing history

  • Previous runs

Create a Plan from Scratch

Use a from-scratch plan when you need a fully custom ingestion workflow.

From-scratch plans provide access to:

  • AI Editor

  • Visual Editor

  • YAML Editor

Create a Custom Plan

  1. Click New Plan.

  2. Select From Scratch.

  1. Enter:

    • Plan name

    • Description

  2. Click Create.

Sprinto creates an empty ingestion workflow and opens the plan overview page.

Build the Workflow Using AI Editor

For most custom workflows, Sprinto recommends starting with the AI Editor.

To open AI Editor:

  1. Open the plan overview page.

  2. Click AI Editor.

Describe the workflow you want Sprinto to build.

Example prompts:

The AI Editor can automatically generate:

  • Workflow steps

  • Entity mappings

  • Parameters

  • Checks

  • Providers

  • Processing logic

Use Advanced Editors

Sprinto also provides advanced editing options for manual workflow configuration.

Click Edit Plan in you plan overview tab to access these editors.

Visual Editor

Use the Visual Editor to manually configure:

  • Plan details

  • Parameters

  • Credentials

  • Providers

  • Steps

  • Outputs

Click Save Changes after you are done with configuring your plan.

YAML Editor

Use the YAML Editor for direct configuration editing.

Note

AML Editor is only available for from-scratch plans. Template-based plans support Visual Editor only.

Use Additional Plan Actions

Each plan includes additional actions available from the three-dot menu.

Available actions include:

Action
Description

Detailed

Opens the plan overview page

Edit

Opens Visual Editor and YAML Editor

AI Editor

Opens the conversational workflow editor

Delete

Permanently removes the plan

Delete or Mark a Plan Inactive

Deleting a plan permanently removes its configuration.

Before deletion, Sprinto allows you to:

  • Confirm the deletion by selecting the I understand this action cannot be undone check box and click Delete.

  • Mark the plan as inactive instead.

Marking a plan inactive disables the workflow without permanently removing the configuration.

Review Ingested Data

After execution completes, review the ingested records.

To review entity records:

  1. Go to Ingestion.

  2. Open the Entities tab.

  3. Select the required entity type.

  4. Click View Entities.

You can review:

  • Ingested records

  • Entity field values

  • Source metadata

  • Monitoring information

Next Steps

After completing the initial setup, you can continue configuring advanced ingestion workflows.

Learn more about:

PreviousOverviewNextBuild and Edit Workflows Using AI Editor

Last updated