Icon

A Transposit port of the Slack blueprint to have new users accept a ToS


Updated July 2019: These are specific instructions for use in Transposit. For other methods, check the Slack API website. Interested in reading more? Check out the blog post we wrote about it!

Sample Slack app that presents a Terms of Service (or any other message) when a new user joins a team.

The user can accept the Terms of Service using message buttons. If a user has been presented with the Terms before and they haven't accepted, a background job can send them a reminder after a specific period of time. Eventually you can use the SCIM API to disable the user's account.

term-of-service

Setup

Create a Slack app

  1. Create an app
  2. Go to Bot Users and click "Add a Bot User" to create an app bot. Save the change.
  3. Enable Interactive components (See Enable Interactive Components below)
  4. Navigate to the OAuth & Permissions page and add the following scopes:
    • chat:write:bot
  5. Add https://accounts.transposit.com/oauth/v2/handle-redirect as a Redirect URI.
  6. Click Save Changes and install the app (You should get an OAuth access token after the installation)
  7. Enable the events (See Enable the Events API below. It doesn't let you the Request URL until you run the code!)
  8. In your Slack workspace, invite the bot to #general, where the new user will join.

Fork in Transposit

  1. Fork this app on Transposit

  2. Configure your Slack app's connection to Transposit:

    1. Find your Client ID and Secret in your Slack app under Basic Information > App Credentials.
    2. In your Transposit app, go to Data connections > Slack > Authentication and change the values to your Slack app's Client ID and Secret.
  3. Add Slack's credential to production under Deploy > Production Keys and follow the instructions.

Enable the Events API

  1. Go back to the app settings and click on Events Subscriptions
  2. Set the Request URL to the generated webhook url for newuser in Transposit under Deploy
  3. On the same page, subscribe to the team_join team events

Enable Interactive Messages

  1. In the app settings, click on Interactive Messages
  2. Set the Request URL to the generated webhook url for acceptpush in Transposit under Deploy > Endpoints

Transposit Functions

acceptpush: The function that is called when the accept button is pressed in Slack.

newuser: The function that is called when a new user joins a workspace.

post_tos: The Slack API call to post the welcome message.

reminder: A scheduled task to remind users who have not accepted the TOS to accept them.