agency-board
POST /v1/agency/boards/{boardId}/automations
Create a rule — when this happens, only if that, then do these.
تصدیقهویت
د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.
دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.
هڅه وکړئ
د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.
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> }'ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ
تفصیلات
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.
پارامترونه
| نوم | ډول | اړین | دا څه شی دی |
|---|---|---|---|
boardId (path) | Uuid | هو | Project board ID (UUIDv7). |
د غوښتنې بدن
| نوم | ډول | اړین | دا څه شی دی |
|---|---|---|---|
name | string | هو | — |
description | string | نه | — |
trigger | string | هو | — |
trigger_config | object | نه | Per-trigger settings, e.g. `hours_before` for "due date approaching". |
conditions | BoardAutomationCondition[] | نه | ANDed. An empty list means the rule always matches its trigger. |
actions | BoardAutomationAction[] | نه | — |
status | string<enabled, disabled> | نه | — |
position | integer | نه | — |
ځواب
| نوم | ډول | اړین | دا څه شی دی |
|---|---|---|---|
id | Uuid | هو | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | هو | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | هو | — |
description | string | نه | — |
trigger | string | هو | — |
trigger_config | object | نه | — |
conditions | BoardAutomationCondition[] | نه | — |
actions | BoardAutomationAction[] | نه | — |
status | BoardAutomationStatus | هو | `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 | نه | — |
run_count | integer | نه | — |
fired_count | integer | نه | — |
consecutive_failures | integer | نه | — |
suspended_reason | string | نه | 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 | نه | — |
last_fired_at | string | نه | — |
last_run_at | string | نه | — |
next_due_at | string | نه | Only set for a wall-clock rule. Null for a rule on a live act. |
created_at | string | نه | — |
updated_at | string | نه | — |
تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي
401 · 403 · 404 · 422