Atlassian: Send notification for issue

← Issues operations · Get started

Operation atlassian.notify

Provider route: POST /{cloudId}/rest/api/3/issue/{issueIdOrKey}/notify. 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["issues"]["notify"]>[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.issues.notify(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.issues.notify(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.issueIdOrKey	string	Required within parent
body	Model	Required within parent	Expand Send notification for issue — request body — body

Referenced models: Send notification for issue — 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
$	null	Root

Schemas

Send notification for issue — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details about a notification. Additional keys: allowed
htmlBody	string	Optional	The HTML body of the email notification for the issue.
restrict	Model	Optional	Expand Send notification for issue — request body — body restrict Restricts the notifications to users with the specified permissions.
subject	string	Optional	The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary.
textBody	string	Optional	The plain text body of the email notification for the issue.
to	Model	Optional	Expand Send notification for issue — request body — body to The recipients of the email notification for the issue.

Referenced models: Send notification for issue — request body — body to, Send notification for issue — request body — body restrict

Send notification for issue — request body — body to

Field	Type	Presence	Description and constraints
$	object	Root	Details of the users and groups to receive the notification. Additional keys: allowed
assignee	boolean	Optional	Whether the notification should be sent to the issue's assignees.
groupIds	array	Optional	List of groupIds to receive the notification.
groupIds[]	string	Each item
groups	array	Optional	List of groups to receive the notification.
groups[]	Model	Each item	Expand Send notification for issue — request body — body to groups item
reporter	boolean	Optional	Whether the notification should be sent to the issue's reporter.
users	array	Optional	List of users to receive the notification.
users[]	Model	Each item	Expand Add comment — request body — body author
voters	boolean	Optional	Whether the notification should be sent to the issue's voters.
watchers	boolean	Optional	Whether the notification should be sent to the issue's watchers.

Referenced models: Send notification for issue — request body — body to groups item, Add comment — request body — body author

Send notification for issue — request body — body restrict

Field	Type	Presence	Description and constraints
$	object	Root	Details of the group membership or permissions needed to receive the notification. Additional keys: not allowed
groupIds	array	Optional	List of groupId memberships required to receive the notification.
groupIds[]	string	Each item
groups	array	Optional	List of group memberships required to receive the notification.
groups[]	Model	Each item	Expand Send notification for issue — request body — body to groups item
permissions	array	Optional	List of permissions required to receive the notification.
permissions[]	Model	Each item	Expand Send notification for issue — request body — body restrict permissions item

Referenced models: Send notification for issue — request body — body to groups item, Send notification for issue — request body — body restrict permissions item

Send notification for issue — request body — body to groups item

Field	Type	Presence	Description and constraints
$	object	Root	Details about a group. Additional keys: not allowed
groupId	JSON	Optional
groupId (anyOf 1)	string	Alternative	The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
groupId (anyOf 2)	null	Alternative
name	string	Optional	The name of group.
self	string	Optional	The URL for these group details. Format: uri Read only: true

Add comment — request body — body author

Field	Type	Presence	Description and constraints
$	object	Root	User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. Additional keys: not allowed
accountId	string	Optional	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Maximum length: 128
accountType	string	Optional	The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) Read only: true
active	boolean	Optional	Whether the user is active. Read only: true
avatarUrls	Model	Optional	Expand Assign issue — request body — body avatar Urls The avatars of the user. Read only: true
displayName	string	Optional	The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. Read only: true
emailAddress	string	Optional	The email address of the user. Depending on the user’s privacy settings, this may be returned as null. Read only: true
key	string	Optional	This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Read only: true
name	string	Optional	This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Read only: true
self	string	Optional	The URL of the user. Read only: true
timeZone	string	Optional	The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. Read only: true

Referenced models: Assign issue — request body — body avatar Urls

Send notification for issue — request body — body restrict permissions item

Field	Type	Presence	Description and constraints
$	object	Root	Details of the permission. Additional keys: allowed
id	string	Optional	The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions.
key	string	Optional	The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions.

Assign issue — request body — body avatar Urls

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
16x16	string	Optional	The URL of the item's 16x16 pixel avatar. Format: uri
24x24	string	Optional	The URL of the item's 24x24 pixel avatar. Format: uri
32x32	string	Optional	The URL of the item's 32x32 pixel avatar. Format: uri
48x48	string	Optional	The URL of the item's 48x48 pixel avatar. Format: uri

Policy, approvals and errors

SDK function policy ID: atlassian.notify. Catalog operation: notify. 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: ["write:jira-work"]

No-content response statuses: [204]

Official provider source