Create user group - Automate.ax

slack.createUserGroup creates a workspace user group.

Example

automations/create-user-group.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { slack } from "automate.ax/slack"

export default automation("Create user group", () => {
  onDashboardRun({ title: "Create user group" })

  slack.createUserGroup({
    name: "Incident Response",
    handle: "incident-response",
    channelIds: ["C01234567"],
  })
})

Inputs

Input	Type	Required	Description
`name`	`string`	Yes	Unique group name.
`handle`	`string`	No	Unique mention handle.
`description`	`string`	No	Group description.
`channelIds`	`string[]`	No	Default channel IDs.
`additionalChannelIds`	`string[]`	No	Extra channels members may add.
`enableSection`	`boolean`	No	Show default channels as a sidebar section.
`includeCount`	`boolean`	No	Include the member count in the response.

Output

Returns the created user group. Requires usergroups:write, a paid Slack plan, and workspace permissions that allow the installed bot to manage user groups.