Loops

Retrieve a Loop

Changed on

Returns the Loop without running it. A webhook Loop shows its URL as event_trigger.url; its key is never returned after creation. Who sees and changes a Loop follows its Reason: the people who can use the Reason see and change its Loops, except that a teammate's Loop on a team Reason stays that teammate's (the Reason's owner may see and stop it). Workspace owners and admins may pause and delete any Loop.What a Loop runs in (its Session or computer), its Slack channels and what wakes it stay with its creator, since each is checked against their access (403 loop_creator_only_change).

<sub>Scope: automations:read</sub>

get/v3/organizations/{orgId}/reasons/{reasonId}/loops/{loopId}

Request

  • Base URL
    https://api.reasonmachines.com
  • URL
    https://api.reasonmachines.com/v3/organizations/{orgId}/reasons/{reasonId}/loops/{loopId}
  • Auth
    HTTP bearer

Response

The Loop.

idstring uuid required

Loop id. Pass it as loopId.

reason_idstring uuid required

The Reason the Loop is filed under; its runs are that Reason's Sessions.

namestring required
promptstring required

The instructions each wake follows.

enabledboolean required
status'active' | 'paused' | 'completed' | 'failed' required

completed when a scheduled Loop reached its until or max_runs; paused names why in paused_reason.

paused_reasonstring nullable required

Why the scheduler paused it (for example out_of_credits or repeated_failures); null when it is not paused or was paused by hand.

trigger_descriptionstring

What wakes it, in words.

slackobject nullable required

The Slack channels that wake it and its health; null when Slack does not.

execution_mode'session' | 'new_session' required
session_idstring nullable required

The Session it is bound to, when one is.

latest_session_idstring nullable required

The Session its most recent wake ran in.

device_idstring nullable required
repositorystring nullable required
modelstring nullable required
notification_policy'important_updates' | 'failed_runs_only' required
untilstring date-time nullable required
max_runsinteger nullable required
run_countinteger required
created_by_user_idstring uuid required

Who created it; its runs are billed as theirs.

Changes