agency-board
POST /v1/agency/boards/{boardId}/automations
Create a rule — when this happens, only if that, then do these.
인증
Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.
이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
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를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. 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