notify
Send notification for issue
Details
- Method:
POST - Path:
/rest/api/3/issue/{issueIdOrKey}/notify - Operation ID:
notify
Parameters
{
"issueIdOrKey": {
"description": "ID or key of the issue that the notification is sent for.",
"required": true,
"location": "path",
"type": "string"
},
"htmlBody": {
"description": "The HTML body of the email notification for the issue.",
"required": false,
"location": "body",
"type": "string"
},
"restrict": {
"description": "Restricts the notifications to users with the specified permissions.",
"required": false,
"location": "body",
"type": "string"
},
"subject": {
"description": "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.",
"required": false,
"location": "body",
"type": "string"
},
"textBody": {
"description": "The plain text body of the email notification for the issue.",
"required": false,
"location": "body",
"type": "string"
},
"to": {
"description": "The recipients of the email notification for the issue.",
"required": false,
"location": "body",
"type": "string"
}
}Response Schema
{}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('notify', {
# Add required parameters here
})