Importer Guide Template

Use this template when creating or updating importer-specific docs.

1. Purpose

• What the importer does
• Which users/systems typically use it
• Current rollout status (beta/ga/internal)

2. Prerequisites

• Required accounts and permissions
• Required secrets/connectors
• Required network/API access

3. Configuration Fields

List each supported field exactly as accepted by the backend schema.

4. Setup Flow

Document the exact setup sequence in numbered steps.

1. Open importer creation flow.
2. Select importer type.
3. Fill required fields.
4. Run/import and verify result.

5. Validation and Error Handling

• Common validation failures
• Error messages users should expect
• Recovery steps

6. Example Payloads

Provide realistic request/argument examples that match deployed behavior.

{
  "importer": "example",
  "arguments": {
    "example_field": "value"
  }
}

7. Operational Notes

• Scheduling behavior
• Idempotency or upsert behavior
• Data freshness expectations

8. Known Limits

• API limits
• Size limits
• Time window limits

9. Troubleshooting

• Symptom
• Likely cause
• Fix

10. Change Log

• YYYY-MM-DD: Initial guide draft.