agency-board
POST /v1/agency/boards/{boardId}/automations
Create a rule — when this happens, only if that, then do these.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
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> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
boardId (path) | Uuid | Oui | Project board ID (UUIDv7). |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
name | string | Oui | — |
description | string | Non | — |
trigger | string | Oui | — |
trigger_config | object | Non | Per-trigger settings, e.g. `hours_before` for "due date approaching". |
conditions | BoardAutomationCondition[] | Non | ANDed. An empty list means the rule always matches its trigger. |
actions | BoardAutomationAction[] | Non | — |
status | string<enabled, disabled> | Non | — |
position | integer | Non | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Oui | — |
description | string | Non | — |
trigger | string | Oui | — |
trigger_config | object | Non | — |
conditions | BoardAutomationCondition[] | Non | — |
actions | BoardAutomationAction[] | Non | — |
status | BoardAutomationStatus | Oui | `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 | Non | — |
run_count | integer | Non | — |
fired_count | integer | Non | — |
consecutive_failures | integer | Non | — |
suspended_reason | string | Non | 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 | Non | — |
last_fired_at | string | Non | — |
last_run_at | string | Non | — |
next_due_at | string | Non | Only set for a wall-clock rule. Null for a rule on a live act. |
created_at | string | Non | — |
updated_at | string | Non | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422