Create

Description

Create a story in Tines.

Request

HTTP Method: POST

Query Parameter Description
team_id ID of team to which the story should be added.
name Optional The story name.
description Optional A user-defined description of the story.
keep_events_for Optional Event retention period in seconds:
1 hour: 3600
6 hours: 21600
1 day: 86400
3 days: 259200
7 days: 604800
14 days: 1209600
30 days: 2592000
60 days: 5184000
90 days: 7776000
180 days: 15552000
365 days: 31536000
folder_id Optional ID of folder to which the story should be added.
tags Optional An array of Strings used to create tags to classify the story.
disabled Optional Boolean flag indicating whether the story is disabled (default: false)
priority Optional Boolean flag indicating if this is a high priority story (default: false).

Sample request

curl -X POST \
  https://<<META.tenant.domain>>/api/v1/stories/ \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
        "name": "Simple story",
        "description": "In the simple story we will create a fictional situation where a detection system is configured to send alerts to our Tines tenant",
        "team_id": 1,
        "folder_id": 1
      }'

Response

A successful request will return a JSON object describing the created story

Field description

Parameter Description
name The story name.
user_id ID of story creator.
description A user-defined description of the story.
keep_events_for Defined event retention period in seconds.
disabled Boolean flag indicating whether story is disabled.
priority Boolean flag indicating whether story is high priority story.
send_to_story_enabled Boolean flag indicating if Send to Story is enabled.
send_to_story_access_source STS, STS_AND_WORKBENCH, WORKBENCH or OFF indicating where the send to story can be used.
send_to_story_access Controls who is allowed to send to this story (TEAM,GLOBAL,SPECIFIC_TEAMS).
shared_team_slugs List of teams' slugs that can send to this story when send_to_story_access is SPECIFIC_TEAMS, otherwise empty.
send_to_story_skill_use_requires_confirmation Boolean flag indicating whether workbench should ask for confirmation before running this story.
entry_agent_id The ID of the entry action for this story.
exit_agents An Array of objects describing exit actions for this story.
team_id ID of team to which the story belongs.
tags An array of tags used to classify the story.
guid Unique identifier of the story.
slug An underscored representation of the story name.
created_at ISO 8601 Timestamp representing date and time the story was created.
updated_at ISO 8601 Timestamp representing date and time the story row was last updated. It is best to use edited_at to track any modifications made to the story itself.
edited_at ISO 8601 Timestamp representing date and time the story was last logically updated.
mode The mode of the story. LIVE or TEST
id The story ID.
folder_id ID of folder to which the story belongs.
published Boolean flag indicating whether the story is published.
change_control_enabled Boolean flag indicating if change control is enabled.
locked Boolean flag indicating whether the story is locked to changes.
owners List of user IDs that are listed as owners on the story.
monitor_failures Boolean flag indicating if monitor failures is enabled on all actions in the story. This will be false when only some actions have monitoring enabled.
actions_with_monitoring List of action IDs with monitoring enabled.
recipients List of monitoring recipients for the story.

Sample response

{
  "name": "Simple story",
  "user_id": 167,
  "description": "In the simple story we will create a fictional situation where a detection system is configured to send alerts to our Tines tenant",
  "keep_events_for": 604800,
  "disabled": false,
  "priority": false,
  "send_to_story_enabled": false,
  "send_to_story_access_source": "OFF",
  "send_to_story_access": null,
  "send_to_story_skill_use_requires_confirmation": true,
  "shared_team_slugs": [],
  "entry_agent_id": null,
  "exit_agents": [],
  "team_id": 1,
  "tags": ["Tag 1", "Tag 2"],
  "guid": "df1e838a18d20696120b41516497b017",
  "slug": "simple_story",
  "created_at": "2021-05-10T08:56:50Z",
  "updated_at": "2021-05-10T08:56:50Z",
  "edited_at": "2021-05-10T08:56:50Z",
  "mode": "LIVE",
  "id": 7981,
  "folder_id": 1,
  "published": true,
  "change_control_enabled": false,
  "locked": false,
  "owners": [1],
  "monitor_failures": false,
  "actions_with_monitoring": [],
  "recipients": [
    {
      "address": "test@example.com"
    }
  ]
}
Was this helpful?