- Overview
- Configuration
ClickUp
Automate ClickUp user and group management with AD integration
By integrating ADManager Plus with ClickUp, organizations can efficiently manage user roles, permissions, and project structures, enhancing operational efficiency, security, and alignment between IT and business processes. This integration leverages the existing user and group data from AD to automatically provision user groups, Spaces, and Teams in ClickUp, ensuring consistency across systems and reducing the need for manual intervention.
Provision group permissions
Ensure user group structures in ClickUp are mirrored in AD, streamlining access controls and group-based permissions across the organization.
Create ClickUp Spaces
Integrating ADManager Plus with ClickUp enables organizations to automatically provision Spaces in ClickUp based on user and group permissions in AD, ensuring seamless access controls and the alignment of project Spaces with organizational roles.
Create ClickUp Teams
When integrated with ADManager Plus, ClickUp allows organizations to automatically create and manage user groups, or Teams, based on AD roles and permissions, ensuring proper user grouping within the Workspace.
Prerequisites
ClickUp uses OAuth 2.0 to authorize API requests and requires the client_id and client_secret credentials for authorization.
Privileges
- To import users (inbound actions): Ensure the account used for authorization has permission to read all user accounts.
- To perform any action or query in ClickUp (outbound actions): Ensure the account used for authorization has permission to perform the desired action.
Authorization configuration
- Log in to ADManager Plus and navigate to the Automation tab.
- On the left pane, under Configuration, click Application Integrations.
- Under Enterprise Applications, click ClickUp.
- On the ClickUp Configuration page, toggle the Enable ClickUp Integration button on.
- Click Authorization.
- Enter the credentials.
- Click Configure.
Inbound webhook configuration
An inbound webhook enables you to import user data from ClickUp into ADManager Plus. The attribute mapping configured in this section can be selected as the data source during automation configuration to perform the desired action on the list of users received from the API response. To configure an inbound webhook for ClickUp:
- Under Inbound Webhook, click ClickUp Endpoint Configuration.
- On the Endpoint Configuration tab, replace {teamId} with the teamId of your ClickUp instance in the Endpoint URL field. If you would like to use a new endpoint to import users, you can configure one by clicking the + Add API Endpoint button and filling in the required fields according to ClickUp's API references. Click here to learn how.
- The API key-value pair is preconfigured as a header for authenticating API requests as configured during authorization configuration.
- You can add macros to your endpoint configuration to dynamically change it according to your requirements using the macro chooser component.
- Refer to ClickUp's API references to configure additional headers and parameters, if required.
- Click Test & Save. A response window will display all the requested parameters that can be fetched using the API call. Click Proceed.
- Refer to ClickUp's API references to know the parameters that must be configured to fetch only specific parameters.
- You can configure multiple endpoints for ClickUp using the + Add API Endpoint button. Click here to learn how.
- Click Data Source - LDAP Attribute Mapping to match endpoints and to map AD LDAP attributes to the respective attributes in ClickUp. ADManager Plus also lets you customize the attribute format from ClickUp.
- Click + Add New Configuration.
- Enter the Configuration Name and Description and select the Automation Category from the drop-down menu.
- In the Select endpoint field, select the desired endpoint and a Primary Key that is unique to a user (e.g., employeeIdentifier).
- In the Attribute Mapping field, select the attribute from the LDAP Attribute Name drop-down menu and map it to the respective column in ClickUp.
- If you would like to create a new custom format for this, click Mapping Attribute.
- Click Save.
- Under Outbound Webhook, click ClickUp Webhook Configuration.
- Click + Add Webhook.
- Enter a name and description for this webhook.
- Decide on the action that has to be performed and refer to ClickUp's API references for the API details, such as the URL, headers, parameters, and other requirements.
- Select the HTTP method that will enable you to perform the desired action on the endpoint from the drop-down menu.
- Enter the endpoint URL.
- Configure the Headers, Parameters, and Message Type in the appropriate format based on the API call that you would like to perform.
- Click Test and Save.
- A pop-up window will then display a list of AD users and groups on which you can test the configured API call. Select the desired users or groups on which this API request has to be tested and click OK. This will make a real-time call to the endpoint URL, and the selected objects will be modified according to the configuration.
- The webhook response and request details will then be displayed. Verify them for the expected API behavior and click Save.
Note:
Note:
Note: When multiple endpoints are configured, this attribute must hold the same value on all the endpoints.
Outbound webhook configuration
An outbound webhook enables you to send changes made in AD to ClickUp and to carry out tasks in ClickUp—all from ADManager Plus. The webhooks configured in the Outbound Webhook section can be included in Orchestration Templates, which in turn can be used during event-driven and scheduled automations. They can also be applied directly to desired users to perform a sequence of actions on them under Management > Advanced Management > Orchestration. To configure an outbound webhook for ClickUp: