Source: https://atomic-works-test.docs-staging.pageloop.ai/ingestion/frequently-asked-questions # Frequently Asked Questions # Frequently Asked Questions ### General Questions #### 1. What is Ingestion in Sprinto? Ingestion is a framework that allows Sprinto to receive, process, transform, and store data from external systems. It helps organisations build custom workflows using: - Plans - Entities - Webhooks These components work together to bring external data into Sprinto for processing and monitoring. --- #### 2. What are the main components of Ingestion? The Ingestion module is built around three core components: - **Plans** — Define how data is processed - **Entities** — Define how data is structured - **Webhooks** — Receive incoming data from external systems Together, they form the ingestion pipeline. --- #### 3. When should I use Ingestion instead of a native integration? Use Ingestion when: - A native Sprinto integration does not exist - You need custom processing logic - External systems provide APIs or webhook payloads - You want to define your own workflow behaviour --- #### 4. Can I use Ingestion without webhooks? Yes. Plans can run independently without webhooks. You can build ingestion workflows using: - Scheduled plans - API-based retrieval - File parsing - Manual execution Webhooks are optional and are typically used for event-driven workflows. --- ### Plans #### 5. What is an ingestion plan? A plan defines how Sprinto retrieves, processes, and stores incoming data. Plans act as workflow pipelines. They can include: - Parameters - Credentials - Providers - Steps - Outputs --- #### 6. What is the difference between a template-based plan and a from-scratch plan? Template-based plans provide preconfigured workflow logic. From-scratch plans provide full control over configuration. Use templates when Sprinto already provides an ingestion workflow. Use from-scratch plans when you need custom behaviour. --- #### 7. Can I edit a template-based plan? Yes. You can modify supported configuration sections such as: - Parameters - Credentials - Providers - Outputs However, certain advanced editing capabilities may be restricted. --- #### 8. Can I use YAML Editor with template-based plans? No. YAML Editor is locked for template-based plans. To edit YAML directly, create a from-scratch plan or duplicate the template workflow into a custom plan. --- #### 9. Can I duplicate a plan? Plan duplication behaviour depends on the current ingestion implementation. If duplication is supported, Sprinto creates a reusable copy of the workflow configuration. --- #### 10. Can a plan run automatically? Yes. Plans can run based on a configured interval. Examples include: - Every 4 hours - Every 8 hours - Every 12 hours - Daily --- #### 11. What happens if required credentials are missing? The plan may fail to execute. Sprinto displays warnings when required credentials are not attached. --- #### 12. Can one plan use multiple providers? Yes. Multiple providers can be attached depending on workflow requirements. --- ### Execution and Debugging #### 13. What is the difference between Run and Debug? **Run** executes the workflow normally. **Debug** allows you to test execution with additional controls. Debug mode provides: - Step-level testing - Range testing - Cache control - Optional data commit --- #### 14. What is Verbose Logging? Verbose Logging generates detailed execution logs. It helps troubleshoot failures and understand step-level behaviour. --- #### 15. What does Disable Cache do? Disable Cache forces Sprinto to ignore cached responses. Use it when: - Testing updated logic - Validating fresh API responses - Troubleshooting stale data --- #### 16. Can I debug a single step? Yes. Debug mode supports: - Entire plan execution - Single-step execution - Step-range execution --- #### 17. What happens if a plan fails? Failure behaviour depends on the step that encountered the issue. You can inspect: - Run History - Run Details - Timeline information - Error messages These details help identify the failure cause. --- #### 18. Where can I see previous runs? Previous runs are available in **Run History**. Run history displays: - Execution status - Start time - Duration - Plan version --- #### 19. Can I restore an older version of a plan? Yes. Use **Revision History** to: - View previous versions - Compare changes - Roll back to an earlier configuration --- ### YAML Editor #### 20. What is YAML Editor used for? YAML Editor provides direct access to the ingestion configuration. It allows advanced users to edit workflow structure manually. --- #### 21. Can I import YAML into Sprinto? Yes. YAML Editor supports importing YAML files. Imported YAML replaces the current configuration. --- #### 22. Can I export YAML? Yes. You can download the YAML configuration from the editor. This is useful for: - Backups - Migration - Version comparison --- #### 23. Does Sprinto validate YAML? Yes. Sprinto validates YAML before saving. Validation checks for: - Formatting issues - Missing required configuration - Schema mismatches --- ### AI Editor #### 24. What is AI Editor? AI Editor is a conversational workspace for editing ingestion plans. You can describe workflow changes using prompts instead of configuring everything manually. --- #### 25. What can AI Editor modify? AI Editor can help configure: - Steps - Entities - Parameters - Providers - Credentials - Checks - Workflow logic --- #### 26. Does AI Editor automatically save changes? No. Changes must be saved manually. You can: - Save changes - Execute the workflow --- #### 27. Can I create entities inside AI Editor? Yes. The AI Editor includes an **Entities** tab where entity types can be created or modified. --- ### Entities #### 28. What is an entity type? An entity type defines the structure used to store ingestion data. It acts as a reusable schema. --- #### 29. What is the difference between an entity type and an entity record? - **Entity Type** = Schema definition - **Entity Record** = Actual ingested data instance --- #### 30. Can I create custom fields? Yes. Entity types support custom fields. Custom fields allow additional metadata to be stored. --- #### 31. What data types are supported for custom fields? Supported types include: - String - Boolean - Long - Double - Timestamp - JSON --- #### 32. Can users edit entity values? Yes. Fields configured with **Allow User Editing** can be modified manually. --- #### 33. What are reference fields? Reference fields create relationships between entity types. They allow ingestion datasets to link together. --- #### 34. Can I add multiple custom fields or reference fields? Yes. Entity types support multiple fields of both types. --- ### Webhooks #### 35. What is a webhook? A webhook is an endpoint that allows external systems to send data into Sprinto. --- #### 36. Do I need a plan for a webhook? Yes. A webhook receives incoming requests, but a plan determines how the data is processed. --- #### 37. Can a webhook exist without an attached plan? Yes. However, requests may not be fully processed until a plan is attached. --- #### 38. What happens when I rotate a webhook ID? Sprinto generates a new webhook URL. After rotation: - The old URL stops working - External systems must update the endpoint --- #### 39. Can I test webhook delivery? Yes. Webhook details include testing examples and request visibility. --- #### 40. What are Recent Events? Recent Events display webhook activity. This includes: - Event timestamps - Processing status - Payload visibility - Event tracking --- #### 41. Can I attach multiple plans to a webhook? Webhook behaviour depends on current Sprinto configuration. Review the attached plans section to confirm supported behaviour. --- #### 42. Can I delete a webhook? Yes. Deleting a webhook permanently removes the endpoint. Deletion cannot be undone. --- ### Troubleshooting #### 43. Why is my plan not running? Common reasons include: - Missing credentials - Invalid step configuration - Incorrect provider setup - Failed API requests - Missing required parameters Review: - Run History - Debug execution - Error logs --- #### 44. Why is my webhook not receiving events? Common causes include: - Incorrect webhook URL - Authentication mismatch - Rate limiting - Payload validation failure - External delivery issues Use Recent Events and testing tools to troubleshoot. --- #### 45. Why are entity records not appearing? Possible reasons include: - Incorrect entity mapping - Failed workflow execution - Missing storage step - Filtering logic preventing insertion Review plan configuration and run logs. --- #### 46. Why is YAML validation failing? Common causes include: - Invalid formatting - Missing required fields - Unsupported schema structure - Incorrect indentation Review inline validation messages inside the YAML Editor.