Overview

Steadybit is highly flexible, and you can seamlessly integrate it into your use cases and processes. For this, we offer various integration points that you can build upon.

Integration Points

Command-Line Interface (CLI)

The CLI is ideal for integrating experiment runs or checking advice into your Continuous Integration/Continuous Delivery (CI/CD) pipeline. Under the hood, it uses the platform's API. Because the CLI is an npm package, it is agnostic to your actual CI/CD tool in action. Learn more about the CLI.

API

The platform's API allows you to perform every action that can be done via the user interface also programmatically. This is ideal for setting up Steadybit in an automated manner, such as creating teams and assigning environments, as well as for advanced use cases involving experiment creation and execution, e.g., utilizing an experiment template to create and run an experiment. Learn more about the API.

Webhooks

The platform offers integrations via webhooks to get notified of events. We differentiate between a custom webhook, which can listen to events to integrate with external systems, and a preflight webhook, which can allow/disallow the starting of experiment runs. Learn more about custom webhooks and preflight webhooks.

Extension Kits

Extension Kits allow you to extend the Chaos Engineering capabilities by adding support for additional technologies or proprietary applications. For instance, to support a custom attack, check, load test, or observability integration, you need to implement DiscoveryKit and ActionKit. EventKit is perfect when you want to react to experiment events, and PreflightKit is perfect whenever you want to have control over starting an experiment run. Last but not least, AdviceKit allows you to ease your rollout by checking organization-specific best practices. Learn more about Extension Kits.

When to use which Integration Point?

This section highlights some key differentiators. Don't hesitate to reach out to us if you need support by discussing your integration use case.

Webhooks vs. Extension Kits

	Sender	Interaction Type	Back-channel	Preventing experiment runs	Stop running Experiments	Listening to experiment lifecycle	Changing Properties
Preflight Webhook	Platform	Synchronous	✅	✅	❌	❌	✅
Custom Webhook	Platform	Asynchronous	❌	❌	❌	✅	❌
PreflightKit	Agent	Asynchronous	✅	✅	✅	❌	✅
EventKit	Agent	Asynchronous	❌	❌	❌	✅	❌
ActionKit	Agent	Asynchronous	✅	❌	️	❌	✅

The remaining Extension Kits (AdviceKit and DiscoveryKit) serve different purposes and are therefore not included in this comparison.

CLI vs. API

	Validate advice status	CRUD of experiments	Run experiments	Use experiment templates	Schedule Experiments	Emergency stop	Read targets
CLI	✅	✅	✅	❌	❌	❌	❌	❌
API	✅	✅	✅	✅	✅	✅	✅	✅