Pause a trigger

agent.trigger.pause

POST/api/v1/households/{household_id}/commands/agent.trigger.pause

Command
Rigel runs it
Applies offline

Stops a trigger from noticing anything until it is resumed; what happens while it is paused is not kept. A run already waiting does nothing. Pausing one that is already paused changes nothing. Fails with trigger_not_found.

Parameters#

Pause a trigger: parameters
Field	Description
`household_id`pathstringrequired	The household's ID.
`Idempotency-Key`headerstringoptional	The command's ID. Reuse it when retrying the same command.

Request body#

JSON, as application/json.

Pause a trigger: request body fields
Field	Description
`trigger_id`stringrequired	A agent trigger ID, such as trg_01JC0000000000000000000000.

Response#

200 The command was applied.

Pause a trigger: response fields
Field	Description
`result`objectrequired	What the command returned, such as the IDs it created.
`result.trigger_id`stringrequired	A agent trigger ID, such as trg_01JC0000000000000000000000.
`version`integerrequired	The household version after the command.

Errors#

Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.

Pause a trigger: errors
Status	Code	When
`400`	`validation_failed`	A field is missing, misspelled or out of range. details.fields lists each problem.
`401`	`unauthenticated`	The request has no valid session.
`404`	`trigger_not_found`	A trigger that isn't there.
`404`	`not_found`	The household doesn't exist, or you aren't a member of it.
`409`	`idempotency_key_reused`	The Idempotency-Key was already used for a different command.

Examples#

These are real. Each scenario is one of the command's test cases, run on a household when this site was built, and the response is what the API returned.

Stops it noticing anything

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/agent.trigger.pause' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000TTTTTTTTTTTTTTTT' \
  -d '{
  "trigger_id": "trg_01JC00000000000000000000T1"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/agent.trigger.pause", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000TTTTTTTTTTTTTTTT",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    trigger_id: "trg_01JC00000000000000000000T1",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/agent.trigger.pause HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000TTTTTTTTTTTTTTTT

{
  "trigger_id": "trg_01JC00000000000000000000T1"
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0H28WM5MKZS323Y0D

{
  "result": {
    "trigger_id": "trg_01JC00000000000000000000T1"
  },
  "version": 1
}

Pausing twice changes nothing

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/agent.trigger.pause' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000VVVVVVVVVVVVVVVV' \
  -d '{
  "trigger_id": "trg_01JC00000000000000000000T1"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/agent.trigger.pause", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000VVVVVVVVVVVVVVVV",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    trigger_id: "trg_01JC00000000000000000000T1",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/agent.trigger.pause HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000VVVVVVVVVVVVVVVV

{
  "trigger_id": "trg_01JC00000000000000000000T1"
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0JM4J2Y53SM3Z7WNV

{
  "result": {
    "trigger_id": "trg_01JC00000000000000000000T1"
  },
  "version": 1
}

A trigger that isn't there

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/agent.trigger.pause' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000WWWWWWWWWWWWWWWW' \
  -d '{
  "trigger_id": "trg_01JC00000000000000000000T1"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/agent.trigger.pause", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000WWWWWWWWWWWWWWWW",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    trigger_id: "trg_01JC00000000000000000000T1",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/agent.trigger.pause HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000WWWWWWWWWWWWWWWW

{
  "trigger_id": "trg_01JC00000000000000000000T1"
}

Response, 404

HTTP/1.1 404 Not Found
Content-Type: application/json
X-Request-Id: req_01K9D9S2R04H08VPDTNVHGEPFR

{
  "error": {
    "code": "trigger_not_found",
    "message": "That trigger isn't there any more. No changes were applied.",
    "details": {
      "trigger_id": "trg_01JC00000000000000000000T1"
    },
    "recovery": "Read the current state, then send a command that fits it.",
    "request_id": "req_01K9D9S2R04H08VPDTNVHGEPFR"
  }
}

Pause a trigger

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/agent.trigger.pause' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01M6V9CTCNAFBX7NG4MYW3DC9Z' \
  -d '{
  "trigger_id": "trg_01M6V9CTCJM5QBJAYNNWJSW67W"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/agent.trigger.pause", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01M6V9CTCNAFBX7NG4MYW3DC9Z",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    trigger_id: "trg_01M6V9CTCJM5QBJAYNNWJSW67W",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/agent.trigger.pause HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01M6V9CTCNAFBX7NG4MYW3DC9Z

{
  "trigger_id": "trg_01M6V9CTCJM5QBJAYNNWJSW67W"
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01M6V9CTCNPS568BWEP92RWS68

{
  "result": {
    "trigger_id": "trg_01M6V9CTCJM5QBJAYNNWJSW67W"
  },
  "version": 321
}

For Rigel#

Rigel's tool for this command is agent_trigger_pause. Rigel runs this on its own, then says what it did. The agent guide has the rest.