Change a trigger

PATCH

/agents/{agentId}/triggers/{triggerId}

const url = 'https://api.asklucy.eu/v1/agents/example/triggers/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"cron":"example","timezone":"example","callback_url":"https://example.com","input":"example","enabled":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.asklucy.eu/v1/agents/example/triggers/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "cron": "example", "timezone": "example", "callback_url": "https://example.com", "input": "example", "enabled": true }'

Its type can’t change. Changing a schedule’s cron or timezone recomputes next_run_at.

Authorizations

zitadel

Parameters

Path Parameters

agentId

required

string

/^agt_[A-Za-z0-9]+$/

triggerId

required

string

/^trg_[A-Za-z0-9]+$/

Request Body^required

application/json

object

>= 1 properties

cron

string

timezone

string

callback_url

string | null format: uri

<= 2000 characters

input

At most 16 KB of JSON; null removes it.

enabled

boolean

Example ^generated

{
  "cron": "example",
  "timezone": "example",
  "callback_url": "https://example.com",
  "input": "example",
  "enabled": true
}

Responses

200

application/json

object

required

string

agent_id

required

string

type

required

string

Allowed values: webhook schedule

enabled

required

boolean

webhook_url

Webhooks: where to POST (receiveAgentWebhook). The URL carries the trigger’s token: it is a credential, like a Slack incoming webhook’s. Only the agent’s managers see triggers (its owner, or org_admins for a service agent), and they can copy it at any time. Null for schedules.

string | null format: uri

cron

Schedules: 5 fields (minute hour day-of-month month day-of-week), at most once every 15 minutes.

string | null

timezone

Schedules: the IANA time zone the cron is read in.

string | null

next_run_at

Schedules: the next time it fires; null while it or its agent is disabled. After an outage a schedule fires once, not once per missed time.

string | null format: date-time

callback_url

required

Where Lucy POSTs each run’s result when it ends (see AgentCallback). https only, to a public address.

string | null format: uri

input

required

Fixed input given to every run it starts (any JSON), next to a webhook’s payload. Null for none.

secret_hint

required

The token’s prefix and last 4 characters, to tell tokens apart.

string

previous_secret_expires_at

After a rotation, until when the previous token (the previous URL) still works.

string | null format: date-time

last_fired_at

string | null format: date-time

created_by

One of:

object
null

object

required

Zitadel user ID.

string

name

required

string

email

string | null format: email

kind

service is a customer system’s Zitadel service user; agent is a service agent (its ID is the agt_ ID), the author of its runs’ messages.

string

Allowed values: person service agent

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "id": "trg_7Lp2WqZs9XcVb4Nm1KjH",
  "type": "webhook",
  "webhook_url": "https://api.asklucy.eu/v1/hooks/trg_7Lp2WqZs9XcVb4Nm1KjH/lwh_5mKq0Zp3Xw8Rt2Lv6Nb9Hc1Jd4Fg7Sa0Ye3Ui6Ok",
  "cron": "0 7 * * 1-5",
  "timezone": "Europe/Luxembourg",
  "secret_hint": "lwh_…x9Qa",
  "created_by": {
    "kind": "person"
  }
}

400

The request is invalid; errors lists what’s wrong.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.

401

Missing, expired or invalid token.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.

404

No such object in your organization.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.

Change a trigger

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example generated

Responses

200

Example

400

Example

Headers

401

Example

Headers

404

Example

Headers

Request Body^required

Example ^generated