Skip to main content

Update Action​

Update an existing ZITADEL action. Actions are custom code written in javascript, that can be run at a specified point/flow/trigger in ZITADEL.

Path Parameters
    id string required
Header Parameters
    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data.

Request Body required
    name string
    script string

    Possible values: non-empty and <= 10000 characters

    Javascript code that should be executed

    timeout string

    after which time the action will be terminated if not finished

    allowedToFail boolean

    when true, the next action will be called even if this action fails

Responses

A successful response.

Schema
    details object
    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

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: 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

    resourceOwner resource_owner is the organization an object belongs to
PUT /actions/:id

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/management/v1
Bearer Token
id — path required
x-zitadel-orgid — header
Content-Type
Body required
{

  "name": "log context",

  "script": "function log(context, calls){console.log(context)}",

  "timeout": "string",

  "allowedToFail": true

}
Accept
curl / cURL
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/actions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "log context",
  "script": "function log(context, calls){console.log(context)}",
  "timeout": "string",
  "allowedToFail": true
}'