Functional Transposit Public MC API
add_activity_field_values
Add items to a activity field multi-value
Parameters
fieldId (required)
The activity field's id. Find the id from either the Activity Fields page or by calling the 'list_fields_for_activity' endpoint and using the 'name' of the returned objects
Type: string
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
$body
The desired values, as a stringified JSON array. In python, use json.dumps(arr) to get the array in the correct format.
Type: string
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
add_related_link
Adds a related link to an activity
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
$body
Type: object
{
"text" : "Required string",
"url" : "Required string"
}
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
attach_slack_channel
Attaches slack channel to activity by channel ID
Parameters
channelId (required)
The slack channel id.
Type: string
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
close_activity
Closes an activity
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
create_activity
Creates a new activity.The fields that can be set for the Activity can be retrieved from the list_fields_for_activity_type
endpoint.
Parameters
team (required)
The Transposit team name.
Type: string
$body
Create activity parameters. Please provide either a title or an originatingEventMetadata object. The 'fields' property will be a map of activity field ids to their desired values. Fields that can have multiple values are represented as arrays. Web link field values are objects with 'url' and 'text' properties. All other values can be sent as strings.
Type: object
{
"description" : "string",
"channelName" : "The name of the Slack channel to create and attach to this activity. This call will fail if this parameter is provided but the activity type is configured to not create Slack channels.",
"originatingEventMetadata" : {
"eventId" : "The Transposit Event ID to use as the 'originating event' of this activity.",
"alertId" : "This field is deprecated."
},
"type" : "The type of the activity. Either the UUID or the activity type name can be used.",
"title" : "The title of the activity. A title is required unless the originatingEventMetadata object is supplied.",
"fields" : "object"
}
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
create_subscription
Subscribes to an activity. Specify the types of events to subscribe to, and the app and operation to be called when a subscribed event type occurs.
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
$body
Type: object
{
"appId" : "The app that will be called when an event occurs, formatted as `orgId/app_name:tag`. e.g. `transposit/transposit_notify_jira:v1.*.*`.",
"operationName" : "The specific operation within the app that will be called when an event occurs.",
"eventTypes" : [ "string. Possible values: DASHBOARD_UPDATE | COMMANDER_UPDATE | LINK_UPDATE | SEVERITY_UPDATE" ],
"parameters" : { }
}
delete_activity_field_value
Unsets all values of a single field for an activity
Parameters
fieldId (required)
The activity field's id. Find the id from either the Activity Fields page or by calling the 'list_fields_for_activity' endpoint and using the 'name' of the returned objects
Type: string
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
delete_commander
Deletes the activity's commander. Note that you may also use the 'update_activity' operation and send over a 'null' for the new value.
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
delete_related_link
Deletes a related link from an activity
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
$body
Type: object
{
"id" : "integer",
"url" : "string"
}
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
delete_severity
Deletes an activity's severity, setting it to None. Note that you may also use the 'update_activity' operation and send over a 'null' for the new value.
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
delete_subscription
Deletes subscription by subscription id. The subscription id can be obtained from the list_subscriptions endpoint.
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
subscription (required)
Type: uuid
team (required)
The Transposit team name.
Type: string
detach_slack_channel
Detaches the slack channel attached to the activity if any
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
get_activity
Gets the details of an activity.
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
get_activity_defaults
Returns activity creation defaults
Parameters
team (required)
The Transposit team name.
Type: string
get_activity_field_value
Returns the JSON for a single field for an activity (may be multi-value)
Parameters
fieldId (required)
The activity field's id. Find the id from either the Activity Fields page or by calling the 'list_fields_for_activity' endpoint and using the 'name' of the returned objects
Type: string
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
get_commander
Gets the activity's commander. Note that, to retrieve multiple activity fields, you can use the 'list_fields_for_activity' operation.
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
get_related_links
Gets related links for an activity. Note that, to retrieve multiple activity fields, you can use the 'list_fields_for_activity' operation.
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
get_run_state
Get the state of a run
Parameters
runId (required)
The id of the runbook run associated with the action. Can be accessed via the 'context' parameter. For example: context.get("runbookRunId")
Type: string
team (required)
The Transposit team name.
Type: string
get_severity
Gets an activity's severity. Note that, to retrieve multiple activity fields, you can use the 'list_fields_for_activity' operation.
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
link_run
Link a run to a stream
Parameters
runId (required)
The id of the runbook run associated with the action. Can be accessed via the 'context' parameter. For example: context.get("runbookRunId")
Type: string
team (required)
The Transposit team name.
Type: string
$body
Type: object
{
"activityPublicId" : "integer",
"triggerId" : "integer"
}
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
list_activities
Lists 1000 most recent activities. Can be filtered by activity status or type
Parameters
team (required)
The Transposit team name.
Type: string
status
Type: string
Potential values: INCIDENT_OPEN, INCIDENT_CLOSED
type
The type of the activity. Either the UUID or the activity type name can be used.
Type: string
list_activity_types
List activity types for a team
Parameters
team (required)
The Transposit team name.
Type: string
list_fields_for_activity
Gets all possible fields for an activity. This includes field types and configurations
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
list_fields_for_activity_type
Gets the fields for an activity type.
Parameters
team (required)
The Transposit team name.
Type: string
type (required)
The type of the activity. Either the UUID or the activity type name can be used.
Type: string
list_subscriptions
Lists subscriptions for an activity
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
list_updates
Lists updates for an activity.
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
post_update
Posts an update to an activity
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
$body
Type: object
{
"originatingEventMetadata" : [ {
"eventId" : "The Transposit Event ID to use as the 'originating event' of this activity.",
"alertId" : "This field is deprecated."
} ],
"eventIds" : [ "string" ],
"updateMessage" : "Required string"
}
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
remove_activity_field_values
Remove only matching items from a activity field multi-value
Parameters
fieldId (required)
The activity field's id. Find the id from either the Activity Fields page or by calling the 'list_fields_for_activity' endpoint and using the 'name' of the returned objects
Type: string
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
$body
The desired values, as a stringified JSON array. In python, use json.dumps(arr) to get the array in the correct format.
Type: string
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
reopen_activity
Reopens an activity
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
set_activity_field_value
Sets the value of a single field for an activity (may be multi-value).
Parameters
fieldId (required)
The activity field's id. Find the id from either the Activity Fields page or by calling the 'list_fields_for_activity' endpoint and using the 'name' of the returned objects
Type: string
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
$body
The desired value, as a JSON string. In python, use json.dumps(str) to get the value in the correct format.
Type: string
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
set_commander
Sets the activity's commander. Note that, to update multiple activity fields, you can use the 'update_activity' operation.
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
$body
Type: object
{
"id" : "Required string"
}
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
set_run_state
Set the state of a run
Parameters
runId (required)
The id of the runbook run associated with the action. Can be accessed via the 'context' parameter. For example: context.get("runbookRunId")
Type: string
team (required)
The Transposit team name.
Type: string
$body
Type: object
{
"state" : "Required string"
}
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
set_severity
Sets an activity's severity. Note that, to update multiple activity fields, you can use the 'update_activity' operation.
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
$body
Type: object
{
"severity" : "Required string. Possible values: SEV0 | SEV1 | SEV2 | SEV3 | SEV4 | SEV5"
}
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
synced_activities
Gets list of synced activities & sync destinations for given sync id + link id
Parameters
linkId (required)
Type: string
syncId (required)
Type: integer
team (required)
Type: string
unlink_run
Unlink a run from a stream
Parameters
runId (required)
The id of the runbook run associated with the action. Can be accessed via the 'context' parameter. For example: context.get("runbookRunId")
Type: string
team (required)
The Transposit team name.
Type: string
$body
Type: object
{
"activityPublicId" : "integer",
"triggerId" : "integer"
}
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string
update_activity
Updates an existing activity. The fields that can be set for the Activity can be programmatically retrieved from the list_fields_for_activity_type
endpoint.
Parameters
id (required)
The integer id of the activity. This can be fetched from the 'incidentId' property in the 'context' parameter.
Type: integer
team (required)
The Transposit team name.
Type: string
$body
Update activity parameters. The 'fields' property will be a map of activity field ids to their desired values. Fields that can have multiple values are represented as arrays. Web link field values are objects with 'url' and 'text' properties. All other values can be sent as strings.
Type: object
{
"description" : "string",
"title" : "string",
"fields" : "object"
}
source
The (optional) token to identify the 'real' caller of the Transposit API, team-authed actions. Can be accessed via the 'context' parameter. For example: context.get("sourceUser", {}).get("token").
Type: string