Connectors Reference

Pivotal Tracker

Pivotal Tracker is purpose-built to make it easy for you to convert an idea into a set of stories that you can prioritize, assign, and manage through completion.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

CreateStory (integer projectId, CreateStoryParameterBody body)

Create a story

ListProjects ()

List projects

GetStory (integer projectId, string storyId)

Get a story

UpdateStory (integer projectId, string storyId, UpdateStoryParameterBody body)

Update a story

DeleteStory (integer projectId, string storyId)

Delete a story

 

Triggers:

Name

Summary

TrigStoryCreated (integer projectId)

When a new story is created

TrigStoryCompleted (integer projectId, [internal]string with_state)

When a story is completed

TrigStoryUpdated (integer projectId)

When a story is updated

 

Objects:

Name

Summary

CreateStoryParameterBody

 

ListProjectsResponseItem

 

Story_Response

 

UpdateStoryParameterBody

 

 

Actions:

CreateStory

Summary: Create a story

Description: This operation is used to create a new story.

 

Syntax:

PivotalTracker.CreateStory (integer projectId, CreateStoryParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectId

integer

(Project Id)

Pick a project.

True

ListProjects

body

CreateStoryParameterBody

 

 

True

 

Returns:

          Type:Story_Response

 

ListProjects

Summary: List projects

Description: List all projects for the current user.

 

Syntax:

PivotalTracker.ListProjects ()

 

Returns:

          Type:array of (ListProjectsResponseItem)

 

GetStory

Summary: Get a story

Description: This operation retrieves all information about a story, given its id.

 

Syntax:

PivotalTracker.GetStory (integer projectId, string storyId)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectId

integer

(Project Id)

Pick a project.

True

ListProjects

storyId

string

(Story Id)

 

True

 

Returns:

          Type:Story_Response

 

UpdateStory

Summary: Update a story

Description: This operation is used to update the details of a story, given its id.

 

Syntax:

PivotalTracker.UpdateStory (integer projectId, string storyId, UpdateStoryParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectId

integer

(Project Id)

Pick a project.

True

ListProjects

storyId

string

(Story Id)

 

True

body

UpdateStoryParameterBody

 

 

True

 

Returns:

          Type:Story_Response

 

DeleteStory

Summary: Delete a story

Description: Deletes the specified story.

 

Syntax:

PivotalTracker.DeleteStory (integer projectId, string storyId)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectId

integer

(Project Id)

Pick a project.

True

ListProjects

storyId

string

(Story Id)

 

True

 

Returns:

          Type:string

 

Triggers:

Trigger TrigStoryCreated

Summary: When a new story is created

Description: Triggers when a new story is added to the given project.

 

Syntax:

PivotalTracker.TrigStoryCreated (integer projectId)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectId

integer

(Project Id)

Pick a project.

True

ListProjects

 

Returns:

          Type:array of (Story_Response)

 

Trigger TrigStoryCompleted

Summary: When a story is completed

Description: Triggers when an existing story is completed in the given project.

 

Syntax:

PivotalTracker.TrigStoryCompleted (integer projectId, [internal]string with_state)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectId

integer

(Project Id)

Pick a project.

True

ListProjects

with_state

string

 

 

True

 

Returns:

          Type:array of (Story_Response)

 

Trigger TrigStoryUpdated

Summary: When a story is updated

Description: Triggers when a story is created or the details of an existing story are updated in the given project.

 

Syntax:

PivotalTracker.TrigStoryUpdated (integer projectId)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectId

integer

(Project Id)

Pick a project.

True

ListProjects

 

Returns:

          Type:array of (Story_Response)

 


 

CreateStoryParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Title

 

description

string

Description

 

story_type

string

Type

Pick a story type.  Values: [feature, bug, chore, release]

current_state

string

State

Pick a completion state.  Values: [accepted, delivered, finished, started, rejected, planned, unstarted, unscheduled]

estimate

integer(int32)

Points

Point value of the story.

accepted_at

string

Acceptance Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

deadline

string

Due Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

requested_by_id

integer(int32)

Requestor Id

User id of the person who requested the story.


 

ListProjectsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

account_id

integer(int32)

Account Id

 

created_at

string(date-time)

Created Date/Time

yyyy-MM-ddTHH:mm:ss.fffZ

current_iteration_number

integer(int32)

Current Iteration Number

 

enable_following

boolean

Enable Following

Allow users to follow stories and epics.

enable_incoming_emails

boolean

Enable Incoming Emails

Allow incoming email responses and convert them to comments.

enable_tasks

boolean

Enable Tasks

Allow individual tasks to be created and managed within each story in the project.

id

integer(int32)

Project Id

 

initial_velocity

integer(int32)

Initial Velocity

 

iteration_length

integer(int32)

Iteration Length

The number of weeks in an iteration.

name

string

Project Name

 

point_scale

string

Point Scale

 

project_type

string

Project Type

 

public

boolean

Is Public

 

start_time

string(date-time)

Start Date/Time

yyyy-MM-ddTHH:mm:ss.fffZ

updated_at

string(date-time)

Update Date/Time

yyyy-MM-ddTHH:mm:ss.fffZ

velocity_averaged_over

integer(int32)

Velocity Averaged Over

The number of iterations that should be used when averaging the number of points of Done stories in order to compute the project's velocity.

version

integer(int32)

Version

 

week_start_day

string

Week Start Day

The day in the week the project's iterations are to start on.


 

Story_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

accepted_at

string(date-time)

Acceptance Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

created_at

string(date-time)

Created Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

current_state

string

State

Story's state of completion.

description

string

Description

In-depth explanation of the story requirements.

estimate

integer(int32)

Points

Point value of the story (feature story type only).

id

integer(int32)

Story Id

The Id of the story.

labels

array of (LabelsItem)

Labels

Story labels.

name

string

Title

Story name.

owner_ids

array of (string)

 

 

project_id

integer(int32)

Project Id

The Id of the project.

requested_by_id

integer(int32)

Requestor Id

The id of the person who requested the story.

story_type

string

Story Type

Type of story.

updated_at

string(date-time)

Updated Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

url

string

URL

The URL of the story.

 

LabelsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Label Id

The Id of the label.

name

string

Label Name

The name of the label.

 


 

UpdateStoryParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Title

 

description

string

Description

 

story_type

string

Type

Pick the story type.  Values: [feature, bug, chore, release]

current_state

string

State

Pick the completion state.  Values: [accepted, delivered, finished, started, rejected, planned, unstarted, unscheduled]

estimate

integer(int32)

Points

Point value of the story.

accepted_at

string

Acceptance Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

deadline

string

Due Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

requested_by_id

integer(int32)

Requestor Id

User id of the person who requested the story.