Skip to content
Docs menu · API reference

Guides

Reference

Reference

API reference

Every ClickRuntime API route with its parameters, body and response fields, from openapi.json.

Every route of the ClickRuntime API, generated from openapi.json. Base URL: https://clickruntime.com/api/v1. Request body fields follow the MCP tool of the same name.

Routes#

GET /apps#

Apps with ready-made connections.

MCP tool: list_app_catalog.

Returns 200 with AppCatalog.

GET /automations#

List automations.

MCP tool: list_automations.

ParameterInTypeDescription
statusquerystringdraft, live or paused.
cursorquerystringnext_cursor from the previous page.
limitqueryintegerPage size.

Returns 200 with AutomationList.

POST /automations#

Save a new draft automation.

MCP tool: save_draft.

Body fieldTypeRequiredDescription
dependenciesarray of objectExtra PyPI packages the script imports that are not built in, such as [{"name": "tenacity", "version": "==9.0.0"}]. Pin an exact version. At most 15. Leave it out to keep the current list; [] removes them all. They install when the script deploys.
deploybooleantrue deploys the change in the same call and waits for the deploy result. Setup must be complete. Leave out to only save.
how_it_worksobjectyesHow the script works, for someone who cannot read code. Required whenever you send a script. steps: 2 to 8 short plain sentences in run order, covering what it reads, what it decides, and what it changes or sends, naming each service it uses. notes: up to 4 sentences for branches that matter, such as what happens when there is nothing to do or a service fails. No code, variable names, or jargon. It must match the script exactly; the card shows it next to the services the server detects in the script.
namestringyesA short name the person will recognise, such as "Morning summary".
patternstring: schedule, incoming, remember_then_scheduleyesschedule: runs on the schedule. incoming: runs when an event arrives at the trigger link. remember_then_schedule: events are stored in state and a scheduled run acts on them.
retryobjectincoming only: how a failed run on an event is retried. Platform errors and timeouts are retried up to max_attempts attempts in total; script errors only when retry_script_errors is true. The default is 3 attempts without script errors. It replaces the whole policy.
scheduleobjectWhen the automation runs. Prefer every_minutes, hourly, daily, weekdays, weekly, or monthly; use cron only when none of them fits, such as the second Tuesday of the month or every 15 minutes during business hours. timezone is an IANA name, required for daily, weekdays, weekly, monthly, and cron; it defaults to UTC for every_minutes and hourly.
scriptstringyesThe complete Python script. Before writing it, you must read the script reference, the MCP resource clickruntime://docs/runtime (read it with resources/read; it is not a tool), or, if you cannot read MCP resources, the same text at https://clickruntime.com/docs/runtime.md; the script must follow them. It needs a @on_trigger (schedule) or @on_event (incoming) handler decorated from clickruntime. Read secrets and connections with clickruntime.credentials; credentials.connection and credentials.secret each return a plain str (the token or value itself, with no .access_token), and the script never gets a refresh token; never write a key's value into the script. Outbound calls are HTTPS only; no subprocess, os.system, multiprocessing or ctypes.
setup_needsarray of objectyesEvery connection account and saved key the script reads through clickruntime.credentials. Before writing the script, call list_connections and ask the person which existing account to use for each service (or confirm the one there is); set up a new account only if they ask or none fits. For a service with no account yet, call list_app_catalog and use a ready-made app whose scopes and limits fit, without asking; draft an app of their own only when none fits. Never pick or invent an account name yourself. A script can read only what is declared here. An empty list means nothing to set up. Never put a key's value here.
signatureobjectincoming and remember_then_schedule only: how the platform checks the sender's signature before a run. It replaces all signature settings at once. Use a named provider when the sender is one of them; use hmac_sha256 for any other sender that signs the raw body with HMAC-SHA256, and set header, encoding, and prefix from the sender's docs. The secret's value is never sent here: name it in secret_name and list the same name in setup_needs so the person saves the value in the application. provider none turns the check off.
summarystringyesOne or two plain sentences saying what happens and when. It appears on the cards.
template_idstringThe starter id when the draft follows a starter from the get-started skill (for example page-summary-email). Leave out otherwise.

Returns 201 with Automation.

GET /automations/{automation_id}#

Get an automation.

MCP tool: get_automation.

ParameterInTypeDescription
automation_idpathstringAutomation id (aut_...).

Returns 200 with Automation.

PATCH /automations/{automation_id}#

Change an automation. A draft is updated in place (update_draft); a live or paused one gets a pending change (change_automation). deploy: true deploys a draft, or asks the person to confirm a live change.

MCP tool: update_draft|change_automation.

ParameterInTypeDescription
automation_idpathstringAutomation id (aut_...).
Body fieldTypeRequiredDescription
dependenciesarray of objectExtra PyPI packages the script imports that are not built in, such as [{"name": "tenacity", "version": "==9.0.0"}]. Pin an exact version. At most 15. Leave it out to keep the current list; [] removes them all. They install when the script deploys.
deploybooleantrue deploys the change in the same call and waits for the deploy result. Setup must be complete. Leave out to only save.
how_it_worksobjectHow the script works, for someone who cannot read code. Required whenever you send a script. steps: 2 to 8 short plain sentences in run order, covering what it reads, what it decides, and what it changes or sends, naming each service it uses. notes: up to 4 sentences for branches that matter, such as what happens when there is nothing to do or a service fails. No code, variable names, or jargon. It must match the script exactly; the card shows it next to the services the server detects in the script.
namestringA short name the person will recognise, such as "Morning summary".
retryobjectincoming only: how a failed run on an event is retried. Platform errors and timeouts are retried up to max_attempts attempts in total; script errors only when retry_script_errors is true. The default is 3 attempts without script errors. It replaces the whole policy.
scheduleobjectWhen the automation runs. Prefer every_minutes, hourly, daily, weekdays, weekly, or monthly; use cron only when none of them fits, such as the second Tuesday of the month or every 15 minutes during business hours. timezone is an IANA name, required for daily, weekdays, weekly, monthly, and cron; it defaults to UTC for every_minutes and hourly.
scriptstringThe complete Python script. Before writing it, you must read the script reference, the MCP resource clickruntime://docs/runtime (read it with resources/read; it is not a tool), or, if you cannot read MCP resources, the same text at https://clickruntime.com/docs/runtime.md; the script must follow them. It needs a @on_trigger (schedule) or @on_event (incoming) handler decorated from clickruntime. Read secrets and connections with clickruntime.credentials; credentials.connection and credentials.secret each return a plain str (the token or value itself, with no .access_token), and the script never gets a refresh token; never write a key's value into the script. Outbound calls are HTTPS only; no subprocess, os.system, multiprocessing or ctypes.
setup_needsarray of objectEvery connection account and saved key the script reads through clickruntime.credentials. Before writing the script, call list_connections and ask the person which existing account to use for each service (or confirm the one there is); set up a new account only if they ask or none fits. For a service with no account yet, call list_app_catalog and use a ready-made app whose scopes and limits fit, without asking; draft an app of their own only when none fits. Never pick or invent an account name yourself. A script can read only what is declared here. An empty list means nothing to set up. Never put a key's value here.
signatureobjectincoming and remember_then_schedule only: how the platform checks the sender's signature before a run. It replaces all signature settings at once. Use a named provider when the sender is one of them; use hmac_sha256 for any other sender that signs the raw body with HMAC-SHA256, and set header, encoding, and prefix from the sender's docs. The secret's value is never sent here: name it in secret_name and list the same name in setup_needs so the person saves the value in the application. provider none turns the check off.
summarystringOne or two plain sentences saying what happens and when. It appears on the cards.

Returns 200 with Automation.

GET /automations/{automation_id}/deploy#

Wait for the latest deploy to finish (long poll, about 45 seconds).

MCP tool: wait_for_deploy.

ParameterInTypeDescription
automation_idpathstringAutomation id (aut_...).

Returns 200 with Automation.

GET /automations/{automation_id}/events#

List events received on the trigger link.

MCP tool: list_incoming_events.

ParameterInTypeDescription
automation_idpathstringAutomation id (aut_...).
cursorquerystringnext_cursor from the previous page.
limitqueryintegerPage size.

Returns 200 with EventList.

GET /automations/{automation_id}/events/latest#

The latest event received on the trigger link.

MCP tool: get_latest_event.

ParameterInTypeDescription
automation_idpathstringAutomation id (aut_...).

Returns 200 with LatestEvent.

POST /automations/{automation_id}/events/{event_id}/replay#

Run a live or paused automation again on an event it received.

MCP tool: replay_event.

ParameterInTypeDescription
automation_idpathstringAutomation id (aut_...).
event_idpathstringEvent id from the events list.

Returns 200 with Run.

POST /automations/{automation_id}/pause#

Pause a live automation. Needs no confirmation.

MCP tool: pause_automation.

ParameterInTypeDescription
automation_idpathstringAutomation id (aut_...).

Returns 200 with Automation.

GET /automations/{automation_id}/runs#

List runs.

MCP tool: list_runs.

ParameterInTypeDescription
automation_idpathstringAutomation id (aut_...).
statusquerystringFilter by run status.
cursorquerystringnext_cursor from the previous page.
limitqueryintegerPage size.

Returns 200 with RunList.

GET /automations/{automation_id}/script#

Get the automation's script.

MCP tool: get_script.

ParameterInTypeDescription
automation_idpathstringAutomation id (aut_...).
versionquerystringA version number, or omit for the current one.

Returns 200 with Script.

GET /automations/{automation_id}/setup#

Setup steps left for the person (connections and keys), each with its link.

MCP tool: get_setup_status.

ParameterInTypeDescription
automation_idpathstringAutomation id (aut_...).

Returns 200 with SetupStatus.

POST /automations/{automation_id}/test-event#

Send a sample event to an incoming automation. Body: {"body": {...}}.

MCP tool: send_test_event.

ParameterInTypeDescription
automation_idpathstringAutomation id (aut_...).
Body fieldTypeRequiredDescription
bodyobjectA realistic sample of the sender's JSON payload. Never include a real key.
confirmation_idstringSet by the confirm card from its own result metadata.

Returns 200 with Run.

POST /confirmations#

Ask the person to confirm turning on, resuming, running, applying a change or deleting. Returns a link for the person; the agent can never confirm.

MCP tool: prepare_confirmation.

Body fieldTypeRequiredDescription
actionstring: enable, resume, run_now, apply_change, delete, send_test_event_liveyesWhat the person wants to do.
automation_idstringyesThe automation id, starting with aut_ (from list_automations or a previous result).
expected_statestringSet by a card: the state it showed. Leave it out.
test_bodyobjectsend_test_event_live only: the sample JSON body to send.

Returns 201 with Confirmation.

GET /confirmations/{confirmation_ref}#

Whether the person confirmed, cancelled, or the link expired.

MCP tool: get_confirmation_status.

ParameterInTypeDescription
confirmation_refpathstringconfirmation_ref from POST /confirmations.

Returns 200 with ConfirmationStatus.

GET /connections#

Connected accounts and saved key names (never values).

MCP tool: list_connections.

Returns 200 with Connections.

POST /connections#

Get a consent link for the person to connect an account.

MCP tool: begin_connection.

Body fieldTypeRequiredDescription
automation_idstringThe automation id, starting with aut_ (from list_automations or a previous result).
namestringThe account name the person chose, such as work or personal. Required unless purpose is notifications.
providerstringyesThe id of a ready-made app from list_app_catalog, the slug of an app from draft_oauth_provider, such as slack or google, or slack with purpose notifications.
purposestring: automation, notificationsautomation (default): a named account scripts fetch. notifications: the single Slack connection used by notify.slack and alerts.

Returns 201 with Connect.

GET /docs/runtime#

The script reference (also at https://clickruntime.com/docs/runtime.md).

Returns 200 with RuntimeDoc.

GET /issues#

Support issues.

MCP tool: list_issues.

ParameterInTypeDescription
statusquerystring
limitqueryinteger

Returns 200 with IssueList.

POST /issues#

Report a problem to ClickRuntime support.

MCP tool: report_issue.

Body fieldTypeRequiredDescription
automation_idstringThe automation id, starting with aut_ (from list_automations or a previous result).
bodystringyesWhat happened, steps, error codes and messages. No keys or tokens.
categorystring: bug, connection, billing, otheryesWhat the issue is about.
run_idstringThe run id, when one run shows the problem.
titlestringyesOne-line summary.

Returns 201 with Issue.

GET /issues/{issue_id}#

A support issue with its messages.

MCP tool: get_issue.

ParameterInTypeDescription
issue_idpathstring

Returns 200 with Issue.

POST /issues/{issue_id}/messages#

Add a message to a support issue.

MCP tool: add_issue_message.

ParameterInTypeDescription
issue_idpathstring
Body fieldTypeRequiredDescription
bodystringyesThe message.

Returns 200 with Issue.

GET /me#

Who is signed in, in which workspace.

MCP tool: get_profile.

Returns 200 with Profile.

POST /oauth-providers#

Draft a custom OAuth app the person finishes in the ClickRuntime dashboard.

MCP tool: draft_oauth_provider.

Body fieldTypeRequiredDescription
auth_paramsobjectExtra authorize parameters the docs require, such as owner=user or access_type=offline.
authorize_urlstringyesThe service's OAuth 2.0 authorization endpoint (https), from its docs.
docs_urlstringThe docs page that explains creating an OAuth app (https).
namestringyesDisplay name, such as Notion.
scope_separatorstring: space, commaHow the service joins scopes. Most use space.
scopesarray of stringThe fewest scopes the script needs, one per item.
setup_notesstringThe setup guide shown on the setup page, written from the service's docs. One step per '## Step title' heading, then plain sentences. Use Exact button or menu name for anything to click, link text for pages to open (link straight to the console page), and value for text to paste (shown with a copy icon). Placeholders: {{redirect_url}} (the callback URL with a copy icon, usable inside a sentence), {{scopes}} (every scope with a copy icon, on its own line), {{client_id}} and {{client_secret}} (required: the input boxes where the person pastes them, on their own lines, in the step where the service shows those values). {{redirect_url}} is required and goes only where the service asks for a redirect or callback URL. The person reads this guide on the ClickRuntime setup page, so never tell them to open it, and do not number titles ('Step 3:'). An optional final '## After connecting' section is shown with the Connect step (for example inviting a bot to channels). ClickRuntime adds the Connect step itself. Never include keys.
slugstringyesShort id for the app, such as notion or hubspot. Used as the provider in setup_needs.
supports_refreshbooleantrue when the service issues refresh tokens; the token is then refreshed before runs. Default true.
token_authstring: body, basicHow the token request sends the client credentials: body (form fields) or basic (HTTP Basic). Use what the docs say; body is the default.
token_urlstringyesThe service's OAuth 2.0 token endpoint (https), from its docs.
use_pkcebooleantrue when the service requires or supports PKCE (S256).

Returns 201 with OAuthProvider.

GET /runs/{run_id}#

Get a run with its logs.

MCP tool: get_run.

ParameterInTypeDescription
run_idpathstringRun id (run_...).
waitquerybooleanWait up to about 45 seconds for a running run to finish.

Returns 200 with Run.

DELETE /session#

Sign out: ends this sign-in for this workspace (MCP and the API), as disconnecting it in the ClickRuntime dashboard does.

Returns 200 with SignedOut.

POST /setup-runs#

Run a one-off discovery or setup script with the person's connections. Nothing is kept.

MCP tool: run_setup_script.

Body fieldTypeRequiredDescription
changesstringRequired for setup: one plain sentence on what the script creates or changes outside ClickRuntime. Leave out for discover.
dependenciesarray of objectExtra PyPI packages the script imports that are not built in, such as [{"name": "tenacity", "version": "==9.0.0"}]. Pin an exact version. At most 15. Leave it out to keep the current list; [] removes them all. They install when the script deploys.
purposestring: discover, setupyesdiscover: only reads, to find out something an automation needs. setup: creates or changes something outside ClickRuntime, once.
scriptstringyesThe complete Python script with an @on_trigger handler from clickruntime. Read the script reference first.
setup_needsarray of objectyesEvery connection account and saved key the script reads through clickruntime.credentials. Before writing the script, call list_connections and ask the person which existing account to use for each service (or confirm the one there is); set up a new account only if they ask or none fits. For a service with no account yet, call list_app_catalog and use a ready-made app whose scopes and limits fit, without asking; draft an app of their own only when none fits. Never pick or invent an account name yourself. A script can read only what is declared here. An empty list means nothing to set up. Never put a key's value here.
titlestringyesA short name the person will recognise, such as "Find the Tally form's fields".

Returns 200 with SetupRun.

Response types#

AppCatalog#

FieldTypePresentDescription
appsarray of object or nullalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
nextNext or nullPresent when the person must act before the agent continues.

Automation#

FieldTypePresentDescription
automation_idstringalways
changesobject or null
connections_usedarray of stringalways
dependenciesarray of anyalways
deployobject or nullDeploy state once it has been turned on.
effectstringWhat turning it on does, in one sentence.
how_it_worksobject or nullalways
how_it_works_gapsarray of anyalways
last_runRun or null
layerobject or nullalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
messagestring
namestringalways
nextNext or nullPresent when the person must act before the agent continues.
notesarray of stringalways
outbound_hostsarray of stringalways
patternstring: schedule, incoming, remember_then_schedulealways
pending_changeobject or null
retryobject or null
scheduleSchedule or null
scriptScriptInfo or null
setupSetup or null
statestringalwaysOpaque version of the automation; pass as expected_state to POST /confirmations.
statusstring: draft, live, pausedalways
summarystringalways
triggerTrigger or null

AutomationList#

FieldTypePresentDescription
automationsarray of AutomationListItemalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
nextNext or nullPresent when the person must act before the agent continues.
next_cursorstring or nullalwaysPass as ?cursor= for the next page; null on the last page.
totalintegeralways

AutomationListItem#

FieldTypePresentDescription
automation_idstringalways
dependency_countintegeralways
last_runRun or nullalways
namestringalways
patternstring: schedule, incoming, remember_then_schedulealways
scheduleSchedule or null
statusstring: draft, live, pausedalways
summarystringalways
triggerTrigger or null

Confirmation#

FieldTypePresentDescription
actionstring: enable, resume, run_now, apply_change, delete, send_test_event_livealways
automation_idstringalways
confirmation_refstringalwaysPoll GET /confirmations/{ref} with it.
effectstring
expires_atstringalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
namestringalways
nextNext or nullPresent when the person must act before the agent continues.
outbound_hostsarray of string
scheduleSchedule or null

ConfirmationStatus#

FieldTypePresentDescription
actionstringalways
automationobject or nullalways
automation_idstringalways
confirmation_refstringalways
decided_atstring or nullalways
decided_viastring or nullalways
deletedboolean
deployobject or nullalways
expires_atstringalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
namestringalways
nextNext or nullPresent when the person must act before the agent continues.
runobject or nullalways
statestring: pending, confirmed, cancelled, expired, usedalwayspending until the person decides.

Connect#

FieldTypePresentDescription
account_labelstring
already_connectedbooleanalways
display_namestringalways
granted_scopesarray of stringalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
namestringalways
new_scopesarray of stringalways
nextNext or nullPresent when the person must act before the agent continues.
providerstringalways
purposestring: automation, notificationsalways
scopes_plainarray of stringalways
used_byarray of stringalways
why_neededstring

Connections#

FieldTypePresentDescription
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
nextNext or nullPresent when the person must act before the agent continues.
notificationsobject or nullalways
providersarray of object or nullalways
secret_namesarray of stringalwaysNames of saved keys. Values are never returned.

Error#

FieldTypePresentDescription
detailsobject or nullExtra fields for the error code, for example missing or retry_after_seconds.
errorstringalwaysStable error code.
messagestringalwaysWhat went wrong, in plain words.
nextNext or null

EventList#

FieldTypePresentDescription
automation_idstringalways
eventsarray of object or nullalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
namestringalways
nextNext or nullPresent when the person must act before the agent continues.
next_cursorstring or nullalways

Issue#

FieldTypePresentDescription
categorystring: bug, connection, billing, otheralways
created_atstringalways
has_support_replybooleanalways
idstringalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
messagesarray of object or null
nextNext or nullPresent when the person must act before the agent continues.
run_idstring
sourcestringalways
statusstring: open, waiting_on_user, resolved, closedalways
titlestringalways
updated_atstringalways

IssueList#

FieldTypePresentDescription
issuesarray of Issuealways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
nextNext or nullPresent when the person must act before the agent continues.

LatestEvent#

FieldTypePresentDescription
automation_idstringalways
eventobject or nullalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
namestringalways
nextNext or nullPresent when the person must act before the agent continues.
statusstringalways
triggerTrigger or null

Next#

FieldTypePresentDescription
actionstring: open_link, login, wait, retry, fix_requestMachine-readable step.
saystringalwaysOne sentence to tell the person.
urlstringLink for the person. Give it exactly as returned; never build or change it.

OAuthProvider#

FieldTypePresentDescription
auth_paramsobject or nullalways
authorize_urlstringalways
callback_urlstringalways
client_id_last4string
has_secretbooleanalwaysTrue once the person saved the app's secret in the ClickRuntime dashboard.
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
missingarray of string
namestringalways
nextNext or nullPresent when the person must act before the agent continues.
provider_idstringalways
scope_separatorstringalways
scopesarray of stringalways
slugstringalways
statusstringalways
supports_refreshbooleanalways
token_authstringalways
token_urlstringalways
use_pkcebooleanalways
warningstring

Profile#

FieldTypePresentDescription
emailstringalways
idstringalwaysStable id for this person in this workspace.
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
namestringalways
nextNext or nullPresent when the person must act before the agent continues.
nicknamestringalways

Run#

FieldTypePresentDescription
attemptintegeralways
automation_idstringalways
automation_namestring
connectionobject or null
countedbooleanalwaysTrue when the run counts toward the plan's runs.
created_atstringalways
duration_msinteger or nullalways
errorstring or nullalways
error_kindstring
eventobject or null
fetchedanyalways
finished_atstring or nullalways
idstringalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
logsarray of any
logs_truncatedboolean
nextNext or nullPresent when the person must act before the agent continues.
scheduled_timestring or nullalways
started_atstring or nullalways
statusstring: queued, running, succeeded, failed, timed_out, skippedalways
summaryanyalways
triggerstringalwaysWhat started the run, for example schedule, incoming or manual.
unbilled_reasonstring or nullalways

RunList#

FieldTypePresentDescription
automation_idstringalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
namestringalways
nextNext or nullPresent when the person must act before the agent continues.
next_cursorstring or nullalways
runsarray of Runalways

RuntimeDoc#

FieldTypePresentDescription
contentstringalwaysThe script reference: handlers, the event object, state, notify, http, and allowed packages.
formatstring: markdownalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
nextNext or nullPresent when the person must act before the agent continues.

Schedule#

FieldTypePresentDescription
armedbooleanalwaysTrue when the schedule is active.
descriptionstringalways
next_runsarray of stringalwaysNext run times, ISO 8601.
specobject or nullalwaysThe schedule as saved: kind, time, timezone.

Script#

FieldTypePresentDescription
automation_idstringalways
codestringalways
linesintegeralways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
nextNext or nullPresent when the person must act before the agent continues.
redactedbooleanalways
sha256stringalways
versionanyalways

ScriptInfo#

FieldTypePresentDescription
linesintegeralways
sha256stringalways

Setup#

FieldTypePresentDescription
itemsarray of SetupItemalways
readybooleanalways

SetupItem#

FieldTypePresentDescription
accountstring
builtinboolean
hintstring
idstringalways
kindstring: connection, secretalways
namestringalways
providerstring
readybooleanalways
scopes_plainarray of string
urlstringWhere the person does this step in the ClickRuntime dashboard. Keys are only ever entered there.
why_neededstring

SetupRun#

FieldTypePresentDescription
attemptintegeralways
automation_idstringalways
automation_namestring
connectionobject or null
countedbooleanalwaysTrue when the run counts toward the plan's runs.
created_atstringalways
duration_msinteger or nullalways
errorstring or nullalways
error_kindstring
eventobject or null
fetchedanyalways
finished_atstring or nullalways
idstringalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
logsarray of any
logs_truncatedboolean
nextNext or nullPresent when the person must act before the agent continues.
purposestring: discover, setupalways
scheduled_timestring or nullalways
setup_run_idstringalways
started_atstring or nullalways
statusstring: queued, running, succeeded, failed, timed_out, skippedalways
summaryanyalways
triggerstringalwaysWhat started the run, for example schedule, incoming or manual.
unbilled_reasonstring or nullalways

SetupStatus#

FieldTypePresentDescription
automation_idstringalways
current_stepobject or null
itemsarray of SetupItemalways
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
namestringalways
nextNext or nullPresent when the person must act before the agent continues.
readybooleanalwaysTrue when every setup step is done.
statusstring: draft, live, pausedalways
stepsarray of stringalwaysSteps left for the person, in order.

SignedOut#

FieldTypePresentDescription
linksobject or nullLinks for the person (ClickRuntime dashboard pages, confirm pages, consent pages). Give them exactly as returned.
nextNext or nullPresent when the person must act before the agent continues.
signed_outbooleanalways

Trigger#

FieldTypePresentDescription
armedbooleanalways
last_event_atstring or null
require_signaturebooleanalways
signatureobject or null
urlstringalwaysTrigger link. An event POSTed to it starts a run.