Skip to main content

Sets an execution to call a target or include the targets of another execution.

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

Setting an empty list of targets will remove all targets from the execution, making it a noop.

Request​

Body

required

    instance

    object

    id string
    domain string

    condition

    object

    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 services and methods 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 services and methods 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.

    execution

    object

    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 services and methods 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 services and methods 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​

Execution successfully updated or left unchanged

Schema

    details

    object

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

    id string
curl -L -X PUT 'https://$CUSTOM-DOMAIN/resources/v3alpha/actions/executions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "instance": {
    "id": "string",
    "domain": "string"
  },
  "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
    }
  },
  "execution": {
    "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
Body required
{
  "instance": {
    "id": "string",
    "domain": "string"
  },
  "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
    }
  },
  "execution": {
    "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!