Connectors Reference

Stormboard

Stormboard Connector

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

CreateIdea ([internal]string Content-Type, [Optional]CreateIdeaParameterBody body)

Create an Idea

RetrieveStorms ([internal]string Content-Type)

Retrieve Storms

CreateStorm ([internal]string Content-Type, [Optional]CreateStormParameterBody body)

Create a Storm

RetrievePlans ([internal]string Content-Type)

Retrieve Plans

 

Triggers:

Name

Summary

LegendChange ([internal]string Content-Type, LegendChangeParameterBody body)

Legend Change

IdeaSection ([internal]string Content-Type, IdeaSectionParameterBody body)

Idea Moved

IdeaCreated ([internal]string Content-Type, IdeaCreatedParameterBody body)

Idea Created

IdeaDeleted ([internal]string Content-type, IdeaDeletedParameterBody body)

Idea Deleted

CommentCreated ([internal]string Content-Type, CommentCreatedParameterBody body)

Comment Created

 

Objects:

Name

Summary

CommentCreatedParameterBody

 

CreateIdeaParameterBody

 

CreateIdeaResponse

 

CreateStormParameterBody

 

CreateStormResponse

 

IdeaCreatedParameterBody

 

IdeaDeletedParameterBody

 

IdeaSectionParameterBody

 

LegendChangeParameterBody

 

RetrievePlansResponse

 

RetrieveStormsResponse

 

 

Actions:

CreateIdea

Summary: Create an Idea

Description: Creates a new Idea in an existing Storm.

 

Syntax:

Stormboard.CreateIdea ([internal]string Content-Type, [Optional]CreateIdeaParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

CreateIdeaParameterBody

 

 

False

 

Returns:

          Type:CreateIdeaResponse

 

RetrieveStorms

Summary: Retrieve Storms

Description: Retrieve Storms

 

Syntax:

Stormboard.RetrieveStorms ([internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

 

Returns:

          Type:RetrieveStormsResponse

 

CreateStorm

Summary: Create a Storm

Description: Creates a new Storm.

 

Syntax:

Stormboard.CreateStorm ([internal]string Content-Type, [Optional]CreateStormParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

CreateStormParameterBody

 

 

False

 

Returns:

          Type:CreateStormResponse

 

RetrievePlans

Summary: Retrieve Plans

Description: Retrieve Plans

 

Syntax:

Stormboard.RetrievePlans ([internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

 

Returns:

          Type:RetrievePlansResponse

 

Triggers:

Trigger LegendChange

Summary: Legend Change

Description: Legend Change

 

Syntax:

Stormboard.LegendChange ([internal]string Content-Type, LegendChangeParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

LegendChangeParameterBody

 

 

True

 

Returns:

 

Trigger IdeaSection

Summary: Idea Moved

Description: Trigger when an idea was moved to a different section of a storm.

 

Syntax:

Stormboard.IdeaSection ([internal]string Content-Type, IdeaSectionParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

IdeaSectionParameterBody

 

 

True

 

Returns:

 

Trigger IdeaCreated

Summary: Idea Created

Description: Trigger when an idea was added to a storm.

 

Syntax:

Stormboard.IdeaCreated ([internal]string Content-Type, IdeaCreatedParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

IdeaCreatedParameterBody

 

 

True

 

Returns:

 

Trigger IdeaDeleted

Summary: Idea Deleted

Description: Trigger when an idea was delete from a storm.

 

Syntax:

Stormboard.IdeaDeleted ([internal]string Content-type, IdeaDeletedParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-type

string

 

 

True

body

IdeaDeletedParameterBody

 

 

True

 

Returns:

 

Trigger CommentCreated

Summary: Comment Created

Description: Trigger when an new comment was posted on an idea.

 

Syntax:

Stormboard.CommentCreated ([internal]string Content-Type, CommentCreatedParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

CommentCreatedParameterBody

 

 

True

 

Returns:

 


 

CommentCreatedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

service

string

service

service

url

string

url

url

events

string

events

events


 

CreateIdeaParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

stormid

integer(int32)

stormid

stormid

type

string

type

type  Values: [text, title]

data

string

data

data

color

string

color

color  Values: [yellow, pink, green, blue, purple, grey, red, silver, orange]


 

CreateIdeaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

id

id

storm

Storm

storm

storm

color

string

color

color

lock

integer(int32)

lock

lock

x

integer(int32)

x

x

y

integer(int32)

y

y

z

integer(int32)

z

z

type

string

type

type

data

Data

data

data

 

Storm

Summary: storm

Description: storm

 

          Properties:

Name

Type

Summary

id

integer(int32)

id

id

title

string

title

title

 

Data

Summary: data

Description: data

 

          Properties:

Name

Type

Summary

text

string

text

text

 


 

CreateStormParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

title

string

title

Storm Title

plan

string

plan

Storm Type

goals

string

goals

Storm Goals and Description

ideacreator

boolean

ideacreator

Show Idea Creator


 

CreateStormResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

id

id

key

string

key

key

title

string

title

title

goals

string

goals

goals

lastactivity

string(date-time)

lastactivity

lastactivity


 

IdeaCreatedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

service

string

service

service

url

string

url

url

events

string

events

events


 

IdeaDeletedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

service

string

service

service

url

string

url

url

events

string

events

events


 

IdeaSectionParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

service

string

service

service

url

string

url

url

events

string

events

events


 

LegendChangeParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

service

string

service

Service

url

string

url

url

events

string

events

Events


 

RetrievePlansResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

plans

array of (PlansItem)

plans

plans

 

PlansItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

id

id

name

string

name

name

 


 

RetrieveStormsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

storms

array of (StormsItem)

storms

storms

 

StormsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

id

id

key

string

key

key

title

string

title

title

status

string

status

status

plan

string

plan

plan