📚 Add operator guide to adding Slack Notifications for sync status. (#…

…6888) * Add operator guide to adding Slack Notifications for sync status. * Remove newlines. * Add link to Demo hours video. * Actually add video.
airbytehq · Oct 12, 2021 · fae6d47 · fae6d47
1 parent fd025dc
commit fae6d47
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 0 deletions.
diff --git a/docs/.gitbook/assets/notifications_add_new_webhook.png b/docs/.gitbook/assets/notifications_add_new_webhook.png
diff --git a/docs/.gitbook/assets/notifications_airbyte_notification_settings.png b/docs/.gitbook/assets/notifications_airbyte_notification_settings.png
diff --git a/docs/.gitbook/assets/notifications_airbyte_settings.png b/docs/.gitbook/assets/notifications_airbyte_settings.png
diff --git a/docs/.gitbook/assets/notifications_create_slack_app.png b/docs/.gitbook/assets/notifications_create_slack_app.png
diff --git a/docs/.gitbook/assets/notifications_incoming_webhooks.png b/docs/.gitbook/assets/notifications_incoming_webhooks.png
diff --git a/docs/.gitbook/assets/notifications_slack_message.png b/docs/.gitbook/assets/notifications_slack_message.png
diff --git a/docs/.gitbook/assets/notifications_webhook_url.png b/docs/.gitbook/assets/notifications_webhook_url.png
diff --git a/docs/operator-guides/configuring-sync-notifications.md b/docs/operator-guides/configuring-sync-notifications.md
@@ -0,0 +1,55 @@
+# Configuring Sync Notifications
+
+## Overview
+
+You can set up Airbyte to notify you when syncs have **failed** or **succeeded**. This is achieved through a webhook, a URL that you can input into other applications to get real time data from Airbyte.
+
+## Set up Slack Notifications on Sync Status
+
+If you're more of a visual learner, just head over to [this video](https://www.youtube.com/watch?v=NjYm8F-KiFc&ab_channel=Airbyte) to learn how to do this. Otherwise, keep reading!
+
+**Set up the bot.**
+
+Navigate to https://api.slack.com/apps/. Hit `Create an App`. 
+
+![](../.gitbook/assets/notifications_create_slack_app.png)   
+
+Then click `From scratch`. Enter your App Name (e.g. Airbyte Sync Notifications) and pick your desired Slack workspace. 
+
+**Set up the webhook URL.**
+
+Now on the left sidebar, click on `Incoming Webhooks`. 
+
+![](../.gitbook/assets/notifications_incoming_webhooks.png)
+
+Click the slider button in the top right to turn the feature on. Then click `Add New Webhook to Workspace`.
+
+![](../.gitbook/assets/notifications_add_new_webhook.png)
+
+Pick the channel that you want to receive Airbyte notifications in (ideally a dedicated one), and click `Allow` to give it permissions to access the channel. You should see the bot show up in the selected channel now.
+
+Now you should see an active webhook right above the `Add New Webhook to Workspace` button.
+
+![](../.gitbook/assets/notifications_webhook_url.png) 
+
+Click `Copy.`
+
+**Add the webhook to Airbyte.**
+
+Assuming you have a [running instance of Airbyte](../deploying-airbyte/README.md), we can navigate to the UI. Click on Settings and then click on `Notifications`.
+
+![](../.gitbook/assets/notifications_airbyte_settings.png)
+
+Simply paste the copied webhook URL in `Connection status Webhook URL` and you're ready to go! On this page, you can click one or both of the sliders to decide whether you want notifications on sync successes, failures, or both. Make sure to click `Save changes` before you leave.
+
+Your Webhook URL should look something like this:
+
+![](../.gitbook/assets/notifications_airbyte_notification_settings.png)
+
+**Test it out.**
+
+From the settings page, you can click `Test` to send a test message to the channel. Or, just run a sync now and try it out! If all goes well, you should receive a notification in your selected channel that looks like this:
+
+![](../.gitbook/assets/notifications_slack_message.png)
+
+You're done!