docs: add missing events to docs

steadybit · Dec 23, 2024 · 3a61736 · 3a61736
1 parent 35bd8db
commit 3a61736
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 # Steadybit EventKit
 
-EventKit allows extensions to consume events from the Steadybit platform to integrate with third-party systems. Extensions leveraging EventKit are similar to webhooks but do not face the typical web routing issues as Steadybit agents handle this aspect. You can use EventKit to:
+EventKit allows extensions to consume events from the Steadybit platform to integrate with third-party systems. Extensions leveraging EventKit are similar to webhooks but do not face the typical web routing issues as Steadybit agents handle this aspect. EventKit focuses on experiment executions. You can use EventKit to:
 
  - Add markers to monitoring systems' charts during experiment executions.
  - Capture experiment execution statistics.

diff --git a/docs/event-api.md b/docs/event-api.md
@@ -60,6 +60,11 @@ Defines the event names that you want to subscribe to. The special case `["*"]`
  - `experiment.execution.step-skipped`
  - `experiment.execution.step-failed`
  - `experiment.execution.step-completed`
+ - `experiment.execution.target-started`
+ - `experiment.execution.target-errored`
+ - `experiment.execution.target-canceled`
+ - `experiment.execution.target-failed`
+ - `experiment.execution.target-completed`
 
 ### References