ACT-CreateDistributionGroup

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

NameDescriptionExample
DisplayNameThe name of the group"HR Alerts"
AliasSMTP alias (before @)"hr-alerts"
IssueKeyJira 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

VersionDateChanges
1.02025-01-01Initial release
1.12025-01-04Added Jira comment + transition support
1.22025-01-06Converted to DisplayName + Alias fields