Ingestion
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:
- Log in to the Sprinto dashboard.
- Go to Ingestion.
- Open the Plans tab.
- 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
- Click New Plan.
- Select From Template.
- Browse the available templates.
- Click Preview on the required template.
- Review:
- Integration details
- Required credentials
- Available checks
- Included configuration
- 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:
- Locate the Parameters section.
- Click Edit.
- Enter the required values.
- 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
- In the Credentials section, click Add Existing.
- Select the required credential.
- Click Attach.
Create a New Credential
- Click Connect next to the required credential.
- Enter the required authentication details.
- 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:
- Open the three-dot menu next to the plan.
- 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:
Add a webhook workflow that processes security alerts from our monitoring platform.Create additional entities for failed login events.Add a step that filters inactive employee records before ingestion.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:
- Open the plan overview page.
- Click Run to execute the workflow immediately.
- Enter the required parameters.
- Select the Disable cache and Verbose logging check box if needed.
- 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
- Click New Plan.
- Select From Scratch.
- Enter:
- Plan name
- Description
- 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:
- Open the plan overview page.
- Click AI Editor.
Describe the workflow you want Sprinto to build.
Example prompts:
Pull employee records from our HR system every 6 hours and store them as entities.Create a workflow that syncs cloud infrastructure data from Vercel.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:
- Go to Ingestion.
- Open the Entities tab.
- Select the required entity type.
- 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:
- Build and edit workflows using AI Editor
- Run and debug ingestion workflows
- Review ingested data and entity records
- Create and manage webhooks
- Edit workflows using YAML Editor