pagehive

complete_command

Close a queued command as done or failed, with an optional note of up to 1000 characters that the page can show the sender.

Agent commandsChanges dataAll plans

What it does

Close a queued command as done or failed, with an optional note of up to 1000 characters that the page can show the sender. Completing a connection test marks the owner's agent connection as working.

Plans

Works on every plan: Free, Basic, Pro and Ultra.

Parameters

NameTypeAbout
site_idrequiredstringThe id of the site. list_sites gives the ids of your sites.
command_idrequiredstringThe id of the queued command, from command_queue.
statusrequiredone of: done, faileddone or failed.
notestring or nullA note of up to 1000 characters that the page can show the sender.

Example

Call complete_command with these arguments:

{
  "site_id": "01a1…",
  "command_id": "01a1…",
  "status": "done",
  "note": "Added 3 recipes."
}

Ids like 01a1… stand for your own. list_sites and list_tables give you the real ones.

Related guides