Update

Description

Update a tines action.

Request

HTTP Method: PUT

Parameter Description
id ID of the action
name Name of the action.
description A user-defined description of the action.
options JSON Options block of the action.
position An object describing the XY coordinates of the action on the story diagram.
source_ids Array of action IDs the action should receive emitted events from.
receiver_ids Array of action IDs the action should emit events to.
schedule An object defining the cron schedule for the action.
disabled Boolean flag indicating whether action is disabled.
monitor_failures Boolean flag indicating if a notification should be sent when this action fails.
monitor_all_events Boolean flag indicating if all events should be monitored.
monitor_no_events_emitted Duration in seconds. If no events are emitted in this time, a notification will be sent. 
curl -X PUT \
  https://<<META.tenant.domain>>/api/v1/agents/<<action_id>> \
  -H 'content-type: application/json' \
  -H 'x-user-token: <api-token>' \
  -d '{
        "name": "New action name"
      }'

Response

A successful request will return a JSON object describing the updated action.

Field description

Parameter Description
id Action ID.
type Action type
user_id User ID of the action's owner.
options JSON Options block of the action.
name Name of the action.
description A user-defined description of the action.
schedule An object defining the cron schedule for the action.
events_count Number of events action has emitted.
last_check_at ISO 8601 Timestamp representing date and time of action's last scheduled run.
last_receive_at ISO 8601 Timestamp representing date and time of last event received.
created_at ISO 8601 Timestamp representing creation date and time of action.
updated_at ISO 8601 Timestamp representing last updated date and time of action.
last_event_at ISO 8601 Timestamp representing date and time the last event was received.
last_error_log_at ISO 8601 Timestamp representing date and time of last error thrown by the action.
disabled Boolean flag indicating whether action is disabled.
guid Unique identifier of the action.
position An object describing the XY coordinates of the action on the story diagram.
story_id ID of story to which the action belongs.
team_id ID of story to which the action belongs.
sources An Array of Action IDs this action receives emitted events from.
receivers An Array of Action IDs this action emits events to.
monitor_failures Boolean flag indicating if a notification should be sent when this action fails.
monitor_all_events Boolean flag indicating if all events should be monitored.
monitor_no_events_emitted Duration in seconds. If no events are emitted in this time, a notification will be sent.
time_unit_saved Unit of time corresponding to time saved value.
time_saved_value Number indicating the amount of time saved.
page An object with information on the associated page, if this is a page action

Sample response

{
  "id": 73563,
  "user_id": 167,
  "type": "Agents::EventTransformationAgent",
  "options": {
    "mode": "deduplicate",
    "path": "{{.propagation_webhook.password}}",
    "lookback": "1"
  },
  "name": "New action name",
  "schedule": [
    {
      "cron": "*/1 * * * *",
      "timezone": "Europe/Dublin"
    }
  ],
  "events_count": 2,
  "last_check_at": "2021-05-07T11:46:50Z",
  "last_receive_at": "2021-05-07T11:46:50Z",
  "created_at": "2021-05-07T11:42:58Z",
  "updated_at": "2021-05-07T11:47:00Z",
  "last_event_at": "2021-05-07T11:47:00Z",
  "last_error_log_at": null,
  "disabled": false,
  "guid": "f3fe6f8e167c9db42e64eaef8e5d2f0c",
  "position": {
    "x": -945,
    "y": 450
  },
  "receivers": [70118],
  "sources": [70116],
  "story_id": 807,
  "team_id": 335,
  "monitor_failures": true,
  "monitor_all_events": true,
  "monitor_no_events_emitted": 86400,
  "time_saved_unit": "minutes",
  "time_saved_value": 10,
  "page": null
}
Was this helpful?