Whitelabel Slack App

Overview

As a reseller, you can add your own Enrollment Notification app for integration. Integrating your Enrollment Notification app will provide the following features:

• Import the members of a workspace as targets in a new group named after the workspace.
• Members of the workspace can receive Slack notifications as well as email notifications of new enrollments.

Use the links below to jump to a section:

1. Requirements
2. Creating your enrollment notification app to install in one Slack workspace
3. Integrating your enrollment notification app in the Integration Store
4. Syncing your workspace members to targets
5. Changing Client ID and Client Secret
6. Install enrollment notification app to more than one workspace
7. Submitting your app to the enrollment notification app directory

Requirements

At a minimum, you will be making a Enrollment Notification app that will contain a bot user with these permissions:

• chat:write,
• team:read,
• users:read, and
• users:read.email.

Also, your redirect URL for the Enrollment Notification app will use your domain.

NOTE: You will need permissions to install Enrollment Notification apps to your desired workspace for the integration to succeed.

Once your Enrollment Notification app is created, you can integrate it in the integration store. After you have installed your Enrollment Notification app in a workspace, tested your changes, and saved your settings, you will be able to install your Enrollment Notification app into other workspaces provided that your Enrollment Notification app is configured to do so.

Back to top

Creating your enrollment notification app to install in one Slack workspace

1. Copy the following App Manifest JSON into a text editor like Notepad or TextEdit

{

    "_metadata": {

        "major_version": 1,

        "minor_version": 1

    },

    "display_information": {

        "name": " My Enrollment Notifier ",

        "description": "You will be notified of a new enrollment.",

        "background_color": "#266cb3",

        "long_description": "My Enrollment Notifier will let any member of your workspace know when they have been enrolled into a course with a message directly to them in your Slack workspace. You can install Enroll Notifier into as many of your workspaces that you need to make for sure that your members receive notifications of their enrollments."

    },

    "features": {

        "bot_user": {

            "display_name": "My Enrollment Notifier",

            "always_online": true

        }

    },

    "oauth_config": {

        "redirect_urls": [

            "https://<your-domain-here>/integration_controller.php"

        ],

        "scopes": {

            "bot": [

                "chat:write",

                "team:read",

                "users:read",

                "users:read.email"

            ]

        }

    },

    "settings": {

        "org_deploy_enabled": false,

        "socket_mode_enabled": false,

        "token_rotation_enabled": false

    }

}

2. Substitute <your-domain-here> in oauth_conifg.redirect_urls with the domain that you use.
   

   NOTE: Once we complete this section of the documentation, it will be easier to modify the other fields for your app.

3. Navigate to slack.com/apps.
4. Click the “Create New App” button.
5. Choose the “From an app manifest” option.
6. Next, you will choose where you will develop your app. This should be a workspace that you have permission to install apps to. If you want to install your Enrollment Notification app into a single workspace, you will choose that workspace here.
7. After clicking "Next" in the previous step, choose JSON as your format. Then, copy and paste your modified App Manifest JSON.
8. The last section is a summary of the app that you are about to create. Click “Create” to continue.
9. At this point, your Enrollment Notification app is ready to be installed through portal into the workspace that you chose in step 6.

Back to top

Integrating your enrollment notification app in the Integration Store

After you install your Enrollment Notification app into your first workspace, you will be able to install your Enrollment Notification app into other workspaces if your app is setup to do so. We will cover how to setup your app to be installed in other workspaces in the Expanding your Enrollment Notification App to install it to more than one workspace section. For now, let’s install your app into a workspace through portal.

1. Navigate to Administration > Integration Store.
2. Click "Setup" on the Slack Integration card.
3. Add your Client ID and Client Secret from your Enrollment Notification app into their corresponding fields. The Client ID and Client Secret can be found in the Basic Information section for your Enrollment Notification app at https://api.slack.com/apps/<your-app-id>.
4. Next, click the “Add to Slack” button. In this screen, you will allow permissions for your app to install into the workspace.
5. If all goes well, you will get a message that the integration was successful.
6. Activate the integration by clicking the “Active” toggle.
7. You will need to save your settings by clicking “Test” then “Save”.
8. At this point, your Enrollment Notification app is installed into the workspace and the users in that work space can receive Slack notifications for new enrollments.
9. If your app is ready to be installed to other workspaces, you can now use the “Add to Slack” button to install your Enrollment Notification app to more workspaces.

Back to top

Syncing your workspace members to targets

1. In the Integration Store, click the Edit button on the Slack Integration card.
2. If you want to sync all of your workspaces into their groups, click the Sync All Groups slider to “Yes”.
3. If you want to sync only some of your workspaces into their groups, click the Sync All Groups slider to “No”. This will bring up a menu for you to choose which groups that you would like to sync.
4. When you are finished, click the "Test" button to test your new settings.
5. Click "Save" to save your settings.

Privacy Policy

Back to top

Changing Client ID and Client Secret

You can integrate one Enrollment Notification app per account. If you need to change what app sends out the Slack notifications, you can do the following:

1. Uninstall all integrated workspaces by choosing “Uninstall” in the Actions column in the Edit Configuration modal for the Enrollment Notification app in the integration store.
2. Change both the Client ID and Client Secret to the new Client ID and Client Secret.
3. Click the “Add to Slack” button and allow permissions to install it into a workspace.
4. Click “Test” then “Save” to save your new settings.
5. At this point, you can install your app into other workspaces if your Enrollment Notification app is set to be publicly distributed.

Back to top

Install enrollment notification app to more than one workspace

If you would like to install your Enrollment Notification app into more than one workspace, you will need to “Activate Public Distribution” for your app. Slack has certain requirements that you must first meet before you can publicly distribute your app. Those requirements are below:

1. Install your app to the workspace that you are developing in.
   • See the Integrating your Enrollment Notification app in the integration store section for how to install your Enrollment Notification app into your workspace.
2. Verify that all hard coded information is removed.
   • You can do this in your Enrollment Notification app settings in slack.com/apps for your app. This is under the “Manage Distribution” section.

After verifying the things above, you will go to the “Manage Distribution” section of your app and click the “Activate Public Distribution” button. Now, you can install your Enrollment Notification app into more than one workspace.

During the install process noted in the Integrating your Enrollment Notification app in the integration store section, you will choose a workspace in step 4:

Back to top

Submitting your app to the enrollment notification app directory

If you want your Enrollment Notification app to be available on the Enrollment Notification app directory, you will need to adhere to Slack’s requirements for submitting your app to the Enrollment Notification app directory. You will, also, need to do the following:

1. Complete the Expanding your Enrollment Notification App to install it to more than one workspace section above to activate your app for public distribution.
2. Fill out all the information needed in the “Basic Information” section of your Enrollment Notification app.
3. In the “Basic Information” page, set your app to “Install from your landing page” in the “Installing Your App” section.
4. Your landing page URL will have information on how to install the Enrollment Notification app along with how to sign up for your services. A clear path to how to get to the “Add to Slack” button will need to be described.
5. On your landing page, you can link to the integration store with a link with a URL like this “https://your-domain/integration_store.php”. Clicking the link will require the user to log in but will direct them to the integration store after they are authenticated which will lead the user to the “Add to Slack” button.

Back to top