- Overview
- Configuration
Snapcomms
Deliver timely communications by syncing Snapcomms users with directories.
Overview
SnapComms is an employee communication platform that enables organizations to deliver targeted internal messages across multiple channels. Integrating SnapComms with ADManager Plus enables automated synchronization of user data between your communication platform and Active Directory. This helps ensure that identity records are consistent, up to date, and aligned across systems used for internal messaging and access control.
Use cases
Standardize user data across AD and SnapComms
Import user profiles from SnapComms into ADManager Plus to maintain consistent identity information across communication and directory services.
Keep AD records in sync with user updates
Automatically update contact details or organizational attributes in AD based on changes made in SnapComms.
Align onboarding workflows
Trigger AD user provisioning based on account creation in SnapComms to streamline onboarding across communication and access systems.
Prerequisites:
Please ensure to provide the bearer token to retrieve desired information and perform tasks in Snapcomms. Refer to Snapcomms API references for more details.
Privileges:
- To import users (inbound action): Ensure the account used for authorization has permission to read all user accounts.
- To perform any action or query in Snapcomms (outbound action): Ensure the account used for authorization has permission to perform the desired action.
Authorization configuration
- Log in to ADManager Plus and navigate to Directory/Application Settings.
- Go to Application Integrations, then search and select Snapcomms.
- Toggle the Enable Snapcomms Integration button on.
- In the Snapcomms Configuration page, click Authorization.
- Perform the steps to generate Bearer token in Snapcomms and paste the Bearer token in the Value field.
- Replace {x-tenant-id}, {x-api-key} value in authorization endpoint's header values with that of your instance.
- Click Configure.
Inbound webhook configuration
Inbound webhook enables you to fetch user data from Snapcomms to ADManager Plus. To configure an inbound webhook for Snapcomms:
- Under Inbound Webhook, click Snapcomms Endpoint Configuration.
- In the Endpoint Configuration tab, an endpoint, Snapcomms- GET ALL USERS ENDPOINT, comes pre-configured with an Endpoint URL, API Method, Headers, and Parameters fields to fetch user accounts from Snapcomms. However, if you would like to use a new endpoint to import users, you can configure one using the + Add API endpoint button and filling in the required fields as per Snapcomms’s API references. Click here to learn how. Note:
- Authorization Header is preconfigured as a header for authenticating API requests as configured during Authorization Configuration.
- Macros: You can add macros to your endpoint configuration to dynamically change it as per your requirement using the macro chooser component. Refer to Snapcomms's API references and configure additional headers and parameters, if required.
- Once done, click Test & Save. A response window will display all the requested parameters that can be fetched using the API call. After verifying if the requested parameters have been called to action, click Proceed. Note:
- Refer to Snapcomms’s API references to know the Parameters that must be configured to fetch only specific parameters.
- You can configure multiple endpoints for Snapcomms 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 with the respective attributes in Snapcomms.
- Click + Add New Configuration and perform the following:
- 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., id).
- In the Attribute Mapping field, select the attribute from the LDAP Attribute Name drop-down menu and map it with the respective column in Snapcomms.
- If you would like to create a new custom format for this, click Add New Format.
- Click Save.
Outbound webhook configuration
Outbound webhook enables you to update the changes made in AD using ADManager Plus to Snapcomms or fetch or forward required details from Snapcomms and synchronize them with AD. They can also be applied directly to desired users to perform a sequence of actions on them (Management > Advanced Management > Orchestration).
To configure an outbound webhook for Snapcomms:
- Under Outbound Webhook, click Snapcomms 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 Snapcomms’s API references for the API details, such as the URL, headers, parameters, and other requirements that will be needed.
- 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 & Save.
- A pop-up window will then display a list of AD users and groups on which to test the configured API call. Select the desired user or group 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.