agency-board

POST `/v1/agency/boards/{boardId}/automations`

Create a rule — when this happens, only if that, then do these.

Pengesahan

Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/automations \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "trigger": <string> }'

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

Validated against the catalogue at save time, not at run time. A rule pairing a card action with a trigger that carries no card, naming a context field its trigger does not publish, or using an operator the field's type cannot take is refused here with the offending clause named — because the alternative is a rule that sits in the list looking enabled and does nothing for ever, whose only evidence is an absence.

Parameter

Nama	Jenis	Diperlukan	Apakah ia
`boardId (path)`	`Uuid`	Ya	Project board ID (UUIDv7).

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`name`	`string`	Ya	—
`description`	`string`	Tidak	—
`trigger`	`string`	Ya	—
`trigger_config`	`object`	Tidak	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Tidak	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Tidak	—
`status`	`string<enabled, disabled>`	Tidak	—
`position`	`integer`	Tidak	—

Respons

Nama	Jenis	Diperlukan	Apakah ia
`id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ya	—
`description`	`string`	Tidak	—
`trigger`	`string`	Ya	—
`trigger_config`	`object`	Tidak	—
`conditions`	`BoardAutomationCondition[]`	Tidak	—
`actions`	`BoardAutomationAction[]`	Tidak	—
`status`	`BoardAutomationStatus`	Ya	`suspended` means WE paused it after repeated failure and it carries a reason the customer has not read. It is a third state rather than a reuse of `disabled`, because collapsin…
`position`	`integer`	Tidak	—
`run_count`	`integer`	Tidak	—
`fired_count`	`integer`	Tidak	—
`consecutive_failures`	`integer`	Tidak	—
`suspended_reason`	`string`	Tidak	Why we paused this rule, in authored copy from a closed table — never an exception, a status or a message from our own code. The per-failure detail lives on each run (`action_re…
`suspended_at`	`string`	Tidak	—
`last_fired_at`	`string`	Tidak	—
`last_run_at`	`string`	Tidak	—
`next_due_at`	`string`	Tidak	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	Tidak	—
`updated_at`	`string`	Tidak	—

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/automations