Create a target​
Create a new target, which can be used in executions.
Request Body required
Possible values: non-empty
and <= 200 characters
Unique name of the target.
restWebhook object
Wait for response but response body is ignored, status is checked, call is sent as post.
Define if any error stops the whole execution. By default the process continues as normal.
restCall object
Wait for response and response body is used, status is checked, call is sent as post.
Define if any error stops the whole execution. By default the process continues as normal.
Call is executed in parallel to others, ZITADEL does not wait until the call is finished. The state is ignored, call is sent as post.
Timeout defines the duration until ZITADEL cancels the execution.
Possible values: non-empty
and <= 1000 characters
Request Body required
Possible values: non-empty
and <= 200 characters
Unique name of the target.
restWebhook object
Wait for response but response body is ignored, status is checked, call is sent as post.
Define if any error stops the whole execution. By default the process continues as normal.
restCall object
Wait for response and response body is used, status is checked, call is sent as post.
Define if any error stops the whole execution. By default the process continues as normal.
Call is executed in parallel to others, ZITADEL does not wait until the call is finished. The state is ignored, call is sent as post.
Timeout defines the duration until ZITADEL cancels the execution.
Possible values: non-empty
and <= 1000 characters
Request Body required
Possible values: non-empty
and <= 200 characters
Unique name of the target.
restWebhook object
Wait for response but response body is ignored, status is checked, call is sent as post.
Define if any error stops the whole execution. By default the process continues as normal.
restCall object
Wait for response and response body is used, status is checked, call is sent as post.
Define if any error stops the whole execution. By default the process continues as normal.
Call is executed in parallel to others, ZITADEL does not wait until the call is finished. The state is ignored, call is sent as post.
Timeout defines the duration until ZITADEL cancels the execution.
Possible values: non-empty
and <= 1000 characters
- 200
- 201
- 403
- 404
- default
A successful response.
Schema
ID is the read-only unique identifier of the target.
details object
Details provide some base information (such as the last change date) of the target.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"id": "string",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.052Z",
"resourceOwner": "69629023906488334"
}
}
Schema
ID is the read-only unique identifier of the target.
details object
Details provide some base information (such as the last change date) of the target.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"id": "string",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.052Z",
"resourceOwner": "69629023906488334"
}
}
Schema
ID is the read-only unique identifier of the target.
details object
Details provide some base information (such as the last change date) of the target.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"id": "string",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.052Z",
"resourceOwner": "69629023906488334"
}
}
Target successfully created
Schema
ID is the read-only unique identifier of the target.
details object
Details provide some base information (such as the last change date) of the target.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"id": "string",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.052Z",
"resourceOwner": "69629023906488334"
}
}
Schema
ID is the read-only unique identifier of the target.
details object
Details provide some base information (such as the last change date) of the target.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"id": "string",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.052Z",
"resourceOwner": "69629023906488334"
}
}
Schema
ID is the read-only unique identifier of the target.
details object
Details provide some base information (such as the last change date) of the target.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"id": "string",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.052Z",
"resourceOwner": "69629023906488334"
}
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}