Source: https://sprinto-test.docs-staging.pageloop.ai/ingestion/dashboard-actions/create-and-configure-an-ingestion-plan

# Create and Configure an Ingestion Plan

An ingestion plan defines how Sprinto retrieves, processes, and stores external data.

Plans act as workflow pipelines that determine:

- Where data comes from
- How it is authenticated
- Which entities receive the data
- What processing logic should run
- Which outputs should be generated

You can create plans using:

- A pre-built template
- A fully custom from-scratch workflow

Both methods eventually open the same plan editor, where you configure workflow behaviour.

---

## Before You Begin

Ensure that:

- You have access to the **Ingestion** module
- Required credentials or API keys are available
- You know which external system the plan will connect to
- Any required entity types already exist, if applicable

---

## Create a Plan from a Template

Templates provide preconfigured ingestion logic for supported workflows.

Use templates when Sprinto already provides a reusable ingestion structure.

### Create a Template-Based Plan

1. Log in to the Sprinto dashboard.
2. Go to **Ingestion**.
3. Open the **Plans** tab.

![](/assets/da0ba09e80a4-screenshot-2026-04-24-at-11.14.44.png)

4. Click **New Plan**.
5. Select **From Template**.

![](/assets/ea9ca2a9e7dc-screenshot-2026-04-24-at-14.14.52.png)

6. Review the available templates.
7. Click **Preview** to inspect a template.

![](/assets/515324c21194-screenshot-2026-04-24-at-14.16.26.png)

8. Review:
   - Template description
   - Included entities
   - Required credentials
   - Workflow details
9. Click **Use This Template**.

![](/assets/f4ac35c7999d-screenshot-2026-04-24-at-14.17.53.png)

10. Configure plan details.

Once created, Sprinto opens the plan configuration page.

---

## Create a Plan from Scratch

Use a from-scratch plan when you need full control over ingestion logic.

### Create a Custom Plan

1. Go to **Ingestion**.
2. Open the **Plans** tab.
3. Click **New Plan**.
4. Select **From Scratch**.

![](/assets/65fa3298c628-screenshot-2026-04-24-at-14.18.32.png)

5. Enter the following details:
   - **Name** (required)
   - **Description** (optional)
6. Click **Create**.

![](/assets/ab514a089e54-screenshot-2026-04-24-at-14.20.11.png)

Sprinto creates a new empty plan and opens the overview page.

---

## Open the Plan Editor

After creating a plan, configure its behaviour through the editor.

1. Open the required plan.
2. Click **Edit Plan**.

The plan editor contains:

- Plan details
- Parameters
- Credentials
- Providers
- Steps
- Outputs

---

## Configure Plan Details

The plan details section controls high-level workflow behaviour. If you have created a plan from scratch, click **Edit Plan** to configure your plan details.

### Plan Fields

| Field       | Description                          |
| ----------- | ------------------------------------ |
| Name        | Displays the plan name               |
| Description | Optional explanation of the workflow |
| Interval    | Defines how often the plan runs      |

### Configure Run Interval

You can schedule the plan to run automatically.

Examples include:

- Every 4 hours
- Every 8 hours
- Every 12 hours
- Daily

The selected interval controls how frequently Sprinto refreshes ingestion data.

![](/assets/6d7361937232-screenshot-2026-04-24-at-14.23.49.png)

---

## Add Parameters

Parameters allow a plan to accept reusable input values.

Parameters are useful when:

- Multiple environments share the same workflow
- Values must change between runs
- Dynamic filtering is required

### Add a Parameter

1. In the **Parameters** section, click **Add Parameter**.

![](/assets/cf0631e18c1e-screenshot-2026-04-24-at-14.25.16.png)

2. Enter a parameter name.
3. Select a parameter type.
4. Add a default value if needed.
5. Enable **Required Parameter** if the value must always be provided.
6. Click **Save Parameter**.

![](/assets/af331c37c4c1-screenshot-2026-04-24-at-14.26.56.png)

The parameter appears in the parameter table.

### Supported Parameter Types

| Type    | Description          |
| ------- | -------------------- |
| String  | Text-based input     |
| Number  | Numeric values       |
| Boolean | True/false values    |
| Array   | Multiple values      |
| Object  | Structured JSON data |

### Edit a Parameter

1. Locate the parameter.
2. Click the **Edit** icon.

![](/assets/b50ed46bdc66-screenshot-2026-04-24-at-14.28.16.png)

3. Update the configuration.
4. Click **Save Parameter**.

### Delete a Parameter

1. Locate the parameter.
2. Click the **Delete** icon.

![](/assets/fc7f759e0b3e-screenshot-2026-04-24-at-14.29.16.png)

3. Click **Delete** to confirm the action.

![](/assets/817a324974f0-screenshot-2026-04-24-at-14.31.33.png)

> [!WARNING]
>
> #### Important
>
> Deleting a parameter cannot be undone.

---

## Attach Credentials

Credentials authenticate external connections.

Plans may require credentials before they can run successfully.

### Attach a Credential

1. In the **Credentials** section, click **Attach Credential**.

![](/assets/ee7cf1dba378-screenshot-2026-04-24-at-14.32.49.png)

2. Select the required integration.
3. Click **Connect**.

![](/assets/1a27c4ea5e7e-screenshot-2026-04-24-at-14.35.36.png)

4. Provide the required authentication details.
5. Click **Connect to \<Credential name>** to attach your credentials.

![](/assets/211c08657bbc-screenshot-2026-04-24-at-14.37.03.png)

The credential becomes attached to the plan.

### Credential Requirements

Depending on the integration, authentication may include:

- API keys
- Bearer tokens
- OAuth credentials
- Secret values

If required credentials are missing, Sprinto displays a warning.

---

## Attach Providers

Providers define the external source associated with the workflow.

A provider represents the integration instance used during ingestion.

### Attach a Provider

1. In the **Providers** section, click **Attach Provider**.

![](/assets/f78690b0ad5c-screenshot-2026-04-24-at-14.38.40.png)

2. Select a provider.
3. Click **Attach**.

![](/assets/9480440d8efc-screenshot-2026-04-24-at-14.40.00.png)

The provider becomes associated with the plan.

---

## Add Workflow Steps

Steps define how ingestion executes.

Each step performs a specific action inside the workflow.

Examples include:

- Fetching data
- Processing records
- Saving entities
- Querying Sprinto data

### Add a Step

1. In the **Steps** section, click **Add Step**.

![](/assets/0aede1271057-screenshot-2026-04-24-at-15.14.04.png)

2. Select a step category.
3. Choose a step type.

![](/assets/69a11eaf6107-screenshot-2026-04-24-at-15.15.11.png)

3. Configure the step.
4. Click **Save Step**.

![](/assets/5dccd523cbba-screenshot-2026-04-24-at-15.17.09.png)

The step appears in the workflow sequence.

---

## Step Categories

Sprinto organises steps into categories.

### Data Fetching

Retrieves information from external systems.

Examples include:

- HTTP Request
- Poll Endpoint
- Download File

### Data Processing

Transforms or reshapes data.

Examples include:

- Parse CSV
- Parse Excel
- Transform Data
- Loop

### Data Storage

Stores or removes ingestion records.

Examples include:

- Insert Entities
- Delete Entities
- Map Entity Type

### Sprinto Query

Retrieves Sprinto-managed information.

Examples include:

- Sprinto Query

---

## Common Step Configuration Fields

Although step drawers vary, several fields are commonly available.

### Step Name

Defines a readable identifier for the step.

### Query or Expression

Some steps require:

- JSONATA expressions
- Queries
- Mapping rules

### Checkpoint

Enable **Checkpoint** to mark a workflow boundary.

### Cache

Enable caching to reuse step output.

### Conditions

Conditional logic determines when the step runs.

### Retry and Attempt Settings

Some steps include:

- Minimum attempts
- Maximum attempts
- Delay intervals

These settings help manage retries and polling behaviour.

---

## Configure Outputs

Outputs expose values generated during workflow execution.

Outputs can reference processed data that should be surfaced after execution.

### Add an Output

1. Scroll to the **Outputs** section.
2. Click **Add Item**.

![](/assets/51918973212c-screenshot-2026-04-24-at-15.25.43.png)

2. Enter an output name.
3. Define the output value.
4. Repeat for additional outputs.

![](/assets/8b8e6c4b1741-screenshot-2026-04-24-at-16.00.32.png)

Outputs are displayed after plan execution.

---

## Save Plan Changes

After configuring the plan:

1. Review all sections.
2. Click **Save Changes**.

![](/assets/93840d4ee721-screenshot-2026-04-24-at-16.01.51.png)

Sprinto validates the configuration before saving.

After saving, Sprinto returns you to the plan overview page.

---

## What Happens Next

Once a plan is configured, you can:

- Run the plan manually
- Debug the workflow
- Review revision history
- View run history
- Open the YAML editor
- Edit through AI Editor

These actions are available from the plan overview page.

---

## Best Practices

Use the following recommendations when configuring plans:

- Use templates when available
- Add clear descriptions for easier maintenance
- Keep parameter names readable
- Attach credentials before configuring API steps
- Organise steps in logical execution order
- Configure outputs for important values
- Save changes regularly
- Validate step logic before running

---

### Related Information

- [Manage Plan Execution and Version History](/ingestion/dashboard-actions/manage-plan-execution-and-version-history)
- [Build and Edit Plans Using YAML and AI Editor](/ingestion/dashboard-actions/build-and-edit-plans-using-yaml-and-ai-editor)
- [Create and Manage Entity Types](/ingestion/dashboard-actions/create-and-manage-entity-types)
- [Create and Manage Webhooks](/ingestion/dashboard-actions/create-and-manage-webhooks)