Skip to content
This repository has been archived by the owner on Jan 30, 2024. It is now read-only.

Integrations

Jump to bottom
Eli Kinsey edited this page May 10, 2022 · 3 revisions

Alerts

Squeak! allows you to add alerts via outgoing webhooks to notify external services when new questions are received.

  1. Visit the Settings page
  2. Under Alerts, click Add alert
  3. Choose between Slack notification or Outgoing webhook (see below for a description on both)
  4. Enter your webhook URL
  5. Click save!

The next time a new question is received, each webhook URL is called.

Slack (moderator alerts)

Receive notifications in Slack when new questions are posted by following these instructions.

  1. Create a Slack app from scratch
  2. Give it a name like Squeak notifications (note: keep the name alphanumeric - exclamation points will break Slack!) and select your workspace
  3. Choose Incoming Webhooks and toggle it ON
  4. At the bottom of the page, click Add New Webhook to Workspace
  5. Select the channel where questions should be posted (we suggest a new channel like #website-questions
  6. Copy the new Webhook URL into Squeak! in the Slack incoming webhook URL field

Outgoing webhook

Squeak! also supports generic outgoing webhooks. Great for Zapier automations! Each time a new question is asked, a POST request will be sent to your webhook URL with following body:

{ subject: 'Test subject', slug: ['/'], body: 'Test question' }

Mailgun

Send email notifications to users when they receive a reply to their question. To configure these, you'll need a Mailgun account. This will allow the notifications to be sent from your domain.

On the Squeak! settings page, you'll need to fill in two fields:

  1. Mailgun API key Mailgun → User → API Keys → Private API Key
  2. Mailgun domain Choose the sending domain from Sending → Domains
  3. Mailgun from name
  4. Mailgun from email

Importing Slack threads

Import recent Slack threads and display them on specific pages of your site. This allows you to answer a question from your Slack community once and let others see your answer where users are most likely to ask it.

  1. Visit Slack tab and follow instructions to create an app from manifest
  2. Install where the threads are (presumably with users) that you'd like to port over to Squeak!
  3. Paste (YAML) manifest from /slack
  4. Install to workspace
  5. Click Oauth and permissions
  6. Under OAuth Tokens for Your Workspace, copy Bot User OAuth Token and add it to Slack
  7. (These instructions are a WIP)
Clone this wiki locally