agency-board
POST /v1/agency/boards/{boardId}/automations
Create a rule — when this happens, only if that, then do these.
Doğrulama
API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.
Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
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> }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
boardId (path) | Uuid | Bəli | Project board ID (UUIDv7). |
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
name | string | Bəli | — |
description | string | Xeyr | — |
trigger | string | Bəli | — |
trigger_config | object | Xeyr | Per-trigger settings, e.g. `hours_before` for "due date approaching". |
conditions | BoardAutomationCondition[] | Xeyr | ANDed. An empty list means the rule always matches its trigger. |
actions | BoardAutomationAction[] | Xeyr | — |
status | string<enabled, disabled> | Xeyr | — |
position | integer | Xeyr | — |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
id | Uuid | Bəli | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Bəli | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Bəli | — |
description | string | Xeyr | — |
trigger | string | Bəli | — |
trigger_config | object | Xeyr | — |
conditions | BoardAutomationCondition[] | Xeyr | — |
actions | BoardAutomationAction[] | Xeyr | — |
status | BoardAutomationStatus | Bəli | `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 | Xeyr | — |
run_count | integer | Xeyr | — |
fired_count | integer | Xeyr | — |
consecutive_failures | integer | Xeyr | — |
suspended_reason | string | Xeyr | 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 | Xeyr | — |
last_fired_at | string | Xeyr | — |
last_run_at | string | Xeyr | — |
next_due_at | string | Xeyr | Only set for a wall-clock rule. Null for a rule on a live act. |
created_at | string | Xeyr | — |
updated_at | string | Xeyr | — |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 422