Atlassian: Add gadget to dashboard

← Dashboards operations · Get started

Operation atlassian.addgadget

Provider route: POST /{cloudId}/rest/api/3/dashboard/{dashboardId}/gadget. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["dashboards"]["addGadget"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.dashboards.addGadget(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.dashboards.add_gadget(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
path.dashboardId	integer	Required within parent	Format: int64
body	Model	Required within parent	Expand Add gadget to dashboard — request body — body

Referenced models: Add gadget to dashboard — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Add gadget to dashboard — response body

Referenced models: Add gadget to dashboard — response body

Schemas

Add gadget to dashboard — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details of the settings for a dashboard gadget. Additional keys: not allowed
color	string	Optional	The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`. write Only: true
ignoreUriAndModuleKeyValidation	boolean	Optional	Whether to ignore the validation of module key and URI. For example, when a gadget is created that is a part of an application that isn't installed. write Only: true
moduleKey	string	Optional	The module key of the gadget type. Can't be provided with `uri`. write Only: true
position	Model	Optional	Expand Add gadget to dashboard — request body — body position The position of the gadget. When the gadget is placed into the position, other gadgets in the same column are moved down to accommodate it.
title	string	Optional	The title of the gadget. write Only: true
uri	string	Optional	The URI of the gadget type. Can't be provided with `moduleKey`. write Only: true

Referenced models: Add gadget to dashboard — request body — body position

Add gadget to dashboard — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details of a gadget.
color	JSON	Optional
color (anyOf 1)	string	Alternative	The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`. Known values: blue, red, yellow, green, cyan, purple, gray, white Read only: true
color (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	JSON	Alternative
id (anyOf 1) (anyOf 1)	integer	Alternative	The ID of the gadget instance. Format: int64 Read only: true
id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id (anyOf 2)	null	Alternative
moduleKey	JSON	Optional
moduleKey (anyOf 1)	string	Alternative	The module key of the gadget type. Read only: true
moduleKey (anyOf 2)	null	Alternative
position	JSON	Optional
position (anyOf 1)	Model	Alternative	Expand Add gadget to dashboard — response body — position Details of a gadget position The position of the gadget. Read only: true
position (anyOf 2)	null	Alternative
title	JSON	Optional
title (anyOf 1)	string	Alternative	The title of the gadget. Read only: true
title (anyOf 2)	null	Alternative
uri	JSON	Optional
uri (anyOf 1)	string	Alternative	The URI of the gadget type. Read only: true
uri (anyOf 2)	null	Alternative

Referenced models: Add gadget to dashboard — response body — position Details of a gadget position

Add gadget to dashboard — request body — body position

Field	Type	Presence	Description and constraints
$	object	Root	Details of a gadget position. write Only: true Additional keys: not allowed
column	integer	Required within parent	The column position of the gadget. Format: int32
row	integer	Required within parent	The row position of the gadget. Format: int32

Add gadget to dashboard — response body — position Details of a gadget position

Field	Type	Presence	Description and constraints
$	object	Root	Details of a gadget position. write Only: true
column	JSON	Optional
column (anyOf 1)	JSON	Alternative
column (anyOf 1) (anyOf 1)	integer	Alternative	The column position of the gadget. Format: int32
column (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
column (anyOf 2)	null	Alternative
row	JSON	Optional
row (anyOf 1)	JSON	Alternative
row (anyOf 1) (anyOf 1)	integer	Alternative	The row position of the gadget. Format: int32
row (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
row (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.addgadget. Catalog operation: addgadget. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-work", "write:jira-work"]

Official provider source