Thank you for your purchase! Here we have compiled a list of the most common and some uncommon features and settings for your reference. If you need something specifically explained please feel free to get in touch.

To begin you will need to download the add-on from your customer area, this will be contained in a .zip archive which you will want to open/extract. You will need to extract the zip and upload all the files from the contained upload directory onto your web server into the root folder of your XenForo Directory. Having uploaded the necessary files, you should log in to the Admin Control Panel of your XenForo Installation and click on 'Install Add-on' under the heading 'Add-ons' on the left-hand side of the Admin Control Panel under the 'Home' tab. Enter the following into the text box labelled 'Install from file on server': install/data/addon-ThemeHouse_Slack.xml Alternatively, extract the zip to a folder on your local computer, and then click 'Choose File' to locate the extracted XML file on your computer.

To start out, you will need to create a new Incoming Webhook, you can do this by navigating to Custom Integrations and search Incoming Webhooks, or click here Choose the default channel you'd like to send messages to. You can change this channel in your options, or per-action. We recommend setting this to #general by default. After you select the channel click "Add Incoming WebHooks integration On this next page, make note of the Webhook URL, you will need that later. This page can be customized as needed, but leaving everything as the defaults should be fine.

In your XenForo admin panel navigate to Home -> Options -> [TH] Slack The only required option on this page is the Webhook URL. Just copy and paste the URL you were given when you created your Webhook Other options on this page will overwrite settings already defined in your webhook. It is generally recommended to leave these blank unless you use the webhook for multiple applications

In your XenForo admin panel navigate to Applications -> Slack -> Slack Actions In the top controls click "Create New Action" Basic Information Name: This is the name you want to give to your action, this is only used in the admin panel to identify the action. Action Execution Order: This is the order in which you want the actions to run. Lower priorities will run first. Once the system finds a match (based on user critera, and other action type specific options) it will run that action and stop searching. Action Type: This is the type of action you wish to create. More detail will be given on this later User Criteria: This behaves the same as any XenForo system that uses User Criteria. Note that all criteria must be met for the action to run, so you cannot set "User is a guest" and "User is logged in" at the same time, for example. Slack Options Webhook URL: If you have a separate webhook URL you'd like to use for only this action you can enter it here. Generally this should be left blank unless you have multiple slack teams. Slackbot Username: This is the username that will be displayed by the notification. Note: This should only contain lowercase alphanumeric characters, and no spaces. We will attempt to fix this for you when we send the notification if it is in an invalid format. Slack Channel: This is the channel notifications matching this action should go to Default icon for notifications: Emoji: If you choose to use an emoji as your icon you will need to enter it in the text format that Slack uses. For example, :smile: will show the smile emoji. Image URL: This option is a bit more straightforward, you just need to use a valid URL to an icon you'd like to use. For action-specific configurations, please continue to the action type you'd like to use.

Sub-Action: New Thread Created: This will send a notification when a new thread has been created Thread Deleted/Undeleted: This will send a notification when a thread has been either hard or soft deleted or if a deleted thread has been restored Forum: You can select a specific forum to run on this, or leave it at 'Any' Only notify if thread requires moderation: If this option is checked, a notification will only be created if the new thread requires moderation

Sub-Action: New Post Created: This will send a notification when a new post has been created Post Deleted/Undeleted: This will send a notification when a post has been either hard or soft deleted or if a deleted post has been restored Forum: You can select a specific forum to run on this, or leave it at 'Any' Contains Text: You can enter a comman-seperated list of words where if one or more of the words appears within the post content, it be sent to Slack. Only notify if post requires moderation: If this option is checked, a notification will only be created if the new post requires moderation

Sub-Action: New User Registered: This will send a notification once a user has registered, and their account has been validated (either by email, or admin approval) New User Awaiting Admin Approval: This will send a notification when a new user registers and they require admin approval User's Email Becomes Invalid: If you use XenForo's email bounce handling this will send a notification if a user's email has bounced too many times and they've been required to revalidate their email User Deleted: This will send a notification when a user's account has been deleted

Sub-Action: New Report: This will send a notification if any content is reported by a user. New Comment on Report: This will send a notification if a moderator comments on a report, or if a user reports content that has already been reported. Report Status Change: This will send a notification if a moderator has changed the status of a report, either by assigning, resolving or rejecting it.

Slack for XenForo

Getting Started with [TH] Slack