agency-board

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

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

Bütün agency-board nöqtələri

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

AdTipTələb olunurNədir
boardId (path)UuidBəliProject board ID (UUIDv7).

Sorğu gövdəsi

AdTipTələb olunurNədir
namestringBəli
descriptionstringXeyr
triggerstringBəli
trigger_configobjectXeyrPer-trigger settings, e.g. `hours_before` for "due date approaching".
conditionsBoardAutomationCondition[]XeyrANDed. An empty list means the rule always matches its trigger.
actionsBoardAutomationAction[]Xeyr
statusstring<enabled, disabled>Xeyr
positionintegerXeyr

Cavab

AdTipTələb olunurNədir
idUuidBəliUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidBəliUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringBəli
descriptionstringXeyr
triggerstringBəli
trigger_configobjectXeyr
conditionsBoardAutomationCondition[]Xeyr
actionsBoardAutomationAction[]Xeyr
statusBoardAutomationStatusBə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…
positionintegerXeyr
run_countintegerXeyr
fired_countintegerXeyr
consecutive_failuresintegerXeyr
suspended_reasonstringXeyrWhy 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_atstringXeyr
last_fired_atstringXeyr
last_run_atstringXeyr
next_due_atstringXeyrOnly set for a wall-clock rule. Null for a rule on a live act.
created_atstringXeyr
updated_atstringXeyr

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 422