Set an execution

PUT 
https://$CUSTOM-DOMAIN/v3alpha/executions

Set an execution to call a previously defined target or include the targets of a previously defined execution.

Request

application/json

Body

required

condition

object

Defines the condition type and content of the condition for execution.

request

object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

response

object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

function

object

Condition-type to execute if function is used, replaces actions v1.

name string

event

object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

targets

object[]

Ordered list of targets/includes called during the execution.

Array [

target string

Unique identifier of existing target to call.

include

object

Unique identifier of existing execution to include targets of.

request

object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

response

object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

function

object

Condition-type to execute if function is used, replaces actions v1.

name string

event

object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

]

application/grpc

Body

required

condition

object

Defines the condition type and content of the condition for execution.

request

object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

response

object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

function

object

Condition-type to execute if function is used, replaces actions v1.

name string

event

object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

targets

object[]

Ordered list of targets/includes called during the execution.

Array [

target string

Unique identifier of existing target to call.

include

object

Unique identifier of existing execution to include targets of.

request

object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

response

object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

function

object

Condition-type to execute if function is used, replaces actions v1.

name string

event

object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

]

application/grpc-web+proto

Body

required

condition

object

Defines the condition type and content of the condition for execution.

request

object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

response

object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

function

object

Condition-type to execute if function is used, replaces actions v1.

name string

event

object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

targets

object[]

Ordered list of targets/includes called during the execution.

Array [

target string

Unique identifier of existing target to call.

include

object

Unique identifier of existing execution to include targets of.

request

object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

response

object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

function

object

Condition-type to execute if function is used, replaces actions v1.

name string

event

object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

]

Responses

200

Execution successfully set

application/json

Schema

Schema

details

object

Details provide some base information (such as the last change date) of the execution.

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

resourceOwner resource_owner is the organization or instance_id an object belongs to (string)

Example (from schema)

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-07-31T12:22:55.090Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc

Schema

Schema

details

object

Details provide some base information (such as the last change date) of the execution.

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

resourceOwner resource_owner is the organization or instance_id an object belongs to (string)

Example (from schema)

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-07-31T12:22:55.091Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc-web+proto

Schema

Schema

details

object

Details provide some base information (such as the last change date) of the execution.

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

resourceOwner resource_owner is the organization or instance_id an object belongs to (string)

Example (from schema)

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-07-31T12:22:55.091Z",
    "resourceOwner": "69629023906488334"
  }
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v3alpha/executions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "condition": {
    "request": {
      "method": "/zitadel.session.v2.SessionService/ListSessions",
      "service": "zitadel.session.v2.SessionService",
      "all": true
    },
    "response": {
      "method": "/zitadel.session.v2.SessionService/ListSessions",
      "service": "zitadel.session.v2.SessionService",
      "all": true
    },
    "function": {
      "name": "string"
    },
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  },
  "targets": [
    {
      "target": "string",
      "include": {
        "request": {
          "method": "/zitadel.session.v2.SessionService/ListSessions",
          "service": "zitadel.session.v2.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2.SessionService/ListSessions",
          "service": "zitadel.session.v2.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      }
    }
  ]
}'

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN

Auth

Bearer Token

Body required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

{
  "condition": {
    "request": {
      "method": "/zitadel.session.v2.SessionService/ListSessions",
      "service": "zitadel.session.v2.SessionService",
      "all": true
    },
    "response": {
      "method": "/zitadel.session.v2.SessionService/ListSessions",
      "service": "zitadel.session.v2.SessionService",
      "all": true
    },
    "function": {
      "name": "string"
    },
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  },
  "targets": [
    {
      "target": "string",
      "include": {
        "request": {
          "method": "/zitadel.session.v2.SessionService/ListSessions",
          "service": "zitadel.session.v2.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2.SessionService/ListSessions",
          "service": "zitadel.session.v2.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      }
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!