Réponse exemple
GET/v1/rules/{id}Récupère une règle d'automatisation par son identifiant.Retourne une règle d'automatisation unique appartenant à l'espace de travail authentifié. La règle est résolue à la fois par son id et par le workspace_id du jeton : une règle appartenant à un autre espace de travail renverra toujours 404, jamais le contenu. La réponse expose les compteurs d'exécution (trigger_count, last_triggered_at) utiles pour suivre l'activité d'une règle.
Authentification
Cette requête nécessite une clé API valide dont le jeton porte le scope transfers:manage. Un scope plus large (par exemple *) satisfait également l'exigence. En l'absence de ce scope, la requête est rejetée avec 403 scope_missing.
Paramètres de requête
| Paramètre | Type | Emplacement | Description |
|---|---|---|---|
| id | string (UUID) | Chemin | Identifiant de la règle à récupérer. Doit appartenir à l'espace de travail du jeton. |
Réponse
Retourne l'objet règle complet. Champs clés : trigger_event (l'événement déclencheur), trigger_conditions (filtres optionnels appliqués au payload de l'événement, ou null), action_type et action_config (l'action exécutée et sa configuration), is_enabled (la règle ne s'exécute que si elle est active), ainsi que last_triggered_at et trigger_count pour le suivi d'activité.
| Champ | Type | Description |
|---|---|---|
| id | string | Identifiant de la règle. |
| name | string | Nom de la règle. |
| description | string | null | Description libre. |
| trigger_event | string | Événement déclencheur (ex. transfer.created). |
| trigger_conditions | object | null | Filtres optionnels sur le payload de l'événement. |
| action_type | string | Type d'action exécutée. |
| action_config | object | Configuration de l'action. |
| is_enabled | boolean | Indique si la règle est active. |
| last_triggered_at | string | null | Date du dernier déclenchement (ISO 8601). |
| trigger_count | number | Nombre total de déclenchements. |
| created_at | string | Date de création (ISO 8601). |
| workspace_id | string | Espace de travail propriétaire. |
Erreurs
| Code | Quand | Résolution |
|---|---|---|
| 401 invalid_api_key | Clé API absente, invalide, expirée ou révoquée. | Vérifiez l'en-tête Authorization et la validité de la clé. |
| 403 scope_missing | Le jeton ne porte pas le scope transfers:manage. | Générez une nouvelle clé incluant transfers:manage sur app.coffrify.com/developer. |
| 404 not_found | Aucune règle avec cet id dans l'espace de travail. | Vérifiez l'identifiant et que la règle appartient bien à votre espace de travail. |
| 429 rate_limited | Quota de requêtes de lecture dépassé pour l'espace de travail. | Patientez selon l'en-tête Retry-After avant de réessayer. |
| 500 internal_error | Erreur interne lors de la lecture en base. | Réessayez ; si le problème persiste, contactez le support avec le request_id. |
Voir aussi
- GET /v1/rules — lister toutes les règles de l'espace de travail.
- PATCH /v1/rules/{id} — mettre à jour une règle existante.
- DELETE /v1/rules/{id} — supprimer une règle et ses exécutions.