# Splunk SOAR SDK

> Splunk SOAR SDK 7.0.1 documentation


2025, Splunk Inc.

## Pages

- [Splunk SOAR SDK Documentation](index.md): The Splunk SOAR SDK is the official tool and library for building connectors that integrate with Spl...
- [Getting Started](getting_started/index.md): In this section we will guide you through the basic process of creating your first Splunk SOAR App.
- [Installation](getting_started/installation.md): The Splunk SOAR Apps SDK is useful both as a CLI tool, for creating and managing Splunk SOAR apps, a...
- [Building an App](getting_started/init_app.md): To build an app with the Splunk SOAR SDK, you can either start from scratch, or migrate an existing ...
- [Defining Your App’s Asset Configuration](getting_started/defining_asset.md): Much of the functionality of a Splunk SOAR app depends on its ability to connect to external systems...
- [Creating Your First Actions](getting_started/first_action.md): All actions are defined as standalone functions, which are then registered with the [`App`](../api_r...
- [Testing and Building the App](getting_started/testing_and_building.md): You can run any of your app’s actions directly in your CLI, without installing a full copy of Splunk...
- [App Structure](app_structure/index.md): In these documentation pages you will find detailed information on the contents of the basic/default...
- [`pyproject.toml`](app_structure/pyproject.toml.md): The `pyproject.toml` is a [standardized file](https://packaging.python.org/en/latest/guides/writing-...
- [`src/app.py`](app_structure/src_app.md): This document will dive deeper into the initial structure of the `app.py` file when starting working...
- [`.pre-commit-config.yaml`](app_structure/pre-commit-config.yaml.md): This file is the official configuration file for the [pre-commit](https://pre-commit.com) tool. It a...
- [Custom Views](custom_views/index.md): In these documentation pages you will find detailed information on creating custom views for your Sp...
- [View Handlers](custom_views/view_handlers.md): View handlers are functions that process action results and prepare data for template rendering. The...
- [Templates](custom_views/templates.md): Templates are Jinja2 HTML files that define how your action results are displayed. They receive data...
- [Reusable Components](custom_views/reusable_components.md): The SDK provides pre-built view components for common data visualization needs. These components han...
- [Authentication](authentication/index.md): These pages cover authentication mechanisms supported by the SDK for integrating with external servi...
- [Basic Authentication](authentication/basic.md): For APIs that use HTTP Basic Authentication (username/password):
- [Static Token Authentication](authentication/static_token.md): For APIs that use API keys or pre-obtained tokens, use `StaticTokenAuth` with httpx:
- [OAuth 2.0 Authentication](authentication/oauth.md): The SDK provides OAuth 2.0 support for SOAR connectors, with automatic token management and secure s...
- [API Reference](api_reference.md): This section documents the public API of the Splunk SOAR SDK.
- [CLI Reference](cli_reference.md): The `soarapps` command-line tool is the main interface for working with Splunk SOAR apps from the co...
- [Changelog](changelog.md): The Splunk SOAR SDK follows a strict semantic versioning and continuous

---

For more comprehensive documentation, see [llms-full.txt](llms-full.txt)