docs: add information on handling of actions v2

This commit is contained in:
Stefan Benz 2025-02-27 14:07:36 +01:00
parent abbdaa9725
commit f11024c887
No known key found for this signature in database
GPG Key ID: 071AA751ED4F9D31

View File

@ -10,6 +10,11 @@ This is useful when you have special business requirements that ZITADEL doesn't
We're working on Actions continuously. In the [roadmap](https://zitadel.com/roadmap), you see how we are planning to expand and improve it. Please tell us about your needs and help us prioritize further fixes and features.
:::
:::warning
To use Actions v2 activate the feature flag "Actions" [feature flag](/docs/apis/resources/feature_service_v2/feature-service-set-instance-features, to be able to manage the related resources.
The Actions v2 will always be executed if available, even if the feature flag is switched off, to remove any Actions v2 the related Execution has to be removed.
:::
## Why actions?
ZITADEL can't anticipate and solve every possible business rule and integration requirements from all ZITADEL users. Here are some examples:
- A business requires domain specific data validation before a user can be created or authenticated.
@ -31,9 +36,13 @@ so that everybody can implement their custom behaviour for as many processes as
Possible conditions for the Execution:
- Request, to react to or manipulate requests to ZITADEL, for example add information to newly created users
- Response, to react to or manipulate responses to ZITADEL, for example to provision newly created users to other systems
- Function, to react to different functionality in ZITADEL, replaces [Actions](/concepts/features/actions)
- Function, to react to different functionality in ZITADEL, replaces [Actions](/concepts/features/actions).
- Event, to create to different events which get created in ZITADEL, for example to inform somebody if a user gets locked
:::info
Currently, the defined Actions v2 will be executed additionally to the defined [Actions](/concepts/features/actions).
:::
## Further reading
- [Actions v2 reference](/apis/actions/v3/usage)