Description
Import a new story. Note that if the story data includes embedded substories these will not be imported.
Request
HTTP Method: POST
| Query Parameter | Description |
|---|---|
| new_name | The new name for the story. |
| data | JSON object representing the story in exported form |
| team_id | ID of team to which the story should be added. |
| folder_id | Optional ID of folder to which the story should be added. |
| mode | Optional Create a new story or update existing by Name (new, versionReplace) default: new |
Response
A successful request will return a JSON object describing the newly 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). |
| send_to_story_referring_story_ids | List of story ids that call this Send to Story enabled story. Only present when send_to_story_enabled is true. |
| 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 the story. |
| recipients | List of monitoring recipients for the story. |