Runbook: ACT-CreateDistributionGroup.ps1
π Description
Creates a Distribution Group in the customerβs on-prem Exchange environment.
This runbook supports:
- Custom display names
- Custom aliases
- Automatic SMTP address construction
- Organizational Unit placement
- Jira ticket updates (comments + workflow transitions)
- Full SymphonyDesk logging
This is typically used for:
- New team creation
- Project distribution lists
- Departmental distribution groups
- Shared communication groups
π§© Required Parameters
| Name | Description | Example |
|---|---|---|
| DisplayName | The name of the group | "HR Alerts" |
| Alias | SMTP alias (before @) | "hr-alerts" |
| IssueKey | Jira issue key for comment updates | "ITSD-5521" |
πͺ Optional Behavior
None β all optional configuration (OU, domain, Exchange routing, authentication) is pulled automatically from the customerβs SymphonyDesk config.
π€ Webhook JSON Example
{
"customer": "Contoso",
"runbook": "ACT-CreateDistributionGroup.ps1",
"issue_key": "{{issue.key}}",
"params": {
"DisplayName": "{{issue.fields.customfield_10300}}",
"Alias": "{{issue.fields.customfield_10301}}",
"IssueKey": "{{issue.key}}"
}
}
π₯ Successful Response
{
"job_id": "job-dg3827ac",
"status": "success",
"output": "Distribution group created successfully"
}
π₯ Error Response
{
"job_id": "job-dg3827ac",
"status": "error",
"message": "Access denied during group creation",
"raw": "New-DistributionGroup : Unable to create group..."
}
π Requirements
- On-prem Exchange Server
- Runner machine must have access to:
- Domain Controller
- Exchange PowerShell Endpoint
- Required Exchange module
- Customer configuration must include:
"ExchangeUri""MailDomain""GroupOU"- Jira credentials stored in secrets.json
π Version History
| Version | Date | Changes |
|---|---|---|
| 1.0 | 2025-01-01 | Initial release |
| 1.1 | 2025-01-04 | Added Jira comment + transition support |
| 1.2 | 2025-01-06 | Converted to DisplayName + Alias fields |

