gitbook-manifest.yaml

name: slack
title: Slack
icon: ./assets/icon.png
description: Ask questions, get answers and add information to your GitBook knowledge base, right in Slack.
categories:
    - collaboration
    - captures
previewImages:
    - ./assets/slack-preview.png
    - ./assets/slack-marketplace-1.png
    - ./assets/slack-marketplace-3.png
externalLinks:
    - label: Documentation
      url: https://docs.gitbook.com/integrations/integrations-beta/slack
    - label: Slack App Directory
      url: https://slack.com/apps/A7DE1QCTD-gitbook?tab=more_info
visibility: public
script: ./src/index.ts
scopes:
    - space:content:read
    - space:metadata:read
    - capture:write
    - snippets:read
summary: |
    # Overview
    With the GitBook Slack integration, your teams have instant access to your GitBook knowledge base, and can get AI-summarized answers about your content. Plus, if you solve a problem in a thread, you can ask GitBook AI to summarize it into useable documentation.

    [Head to our documentation to find out more](https://docs.gitbook.com/integrations/integrations-beta/slack)

    # How it works
    **Find information faster:** Getting an answer has never been easier. Just summon our Slackbot and ask a question — GitBook AI will scan your documentation and summarize an answer in seconds.

    **Turn conversations into documentation:** Just solved a problem in an epic, 168-message thread? Ask GitBook AI to summarize the conversation and it’ll save it to your knowledge base so anyone can find out how you got there.

    **Real-time notifications:** Get notified in real-time when something important happens with your GitBook content — from small updates, to someone publishing a space. You choose what you get notifications for, and where you see them.

    # Configure
    To install on a single space, click Integrations in the sub-nav within the GitBook app. Alternatively, you can install it across all your spaces in Settings.
    Once you’ve installed it, head over to Slack and authorize the connection. You can select a default channel to post notifications and other messages, but remember — you can summon GitBook in any channel or thread.

    [Read our documentation to learn more](https://docs.gitbook.com/integrations/integrations-beta/slack)
configurations:
    account:
        properties:
            oauth_credentials:
                type: button
                title: Connection
                description: Authorization between Slack and GitBook.
                button_text: Authorize
                callback_url: /oauth
            default_channel:
                type: string
                title: Default Channel
                description: Select a channel to post messages to, when none is configured for a specific space.
                completion_url: /channels
        required:
            - oauth_credentials
            - default_channel
    space:
        properties:
            channel:
                type: string
                title: Channel
                description: Select a channel to post messages related to this space.
                completion_url: /channels
            notify_content_update:
                type: boolean
                title: Notify Content Update
                description: Post a notification message every time the content of the space is updated.
                default: true
            notify_visibility_update:
                type: boolean
                title: Notify Visibility Update
                description: Post a notification message every time the visibility of the space is updated.
                default: true
secrets:
    CLIENT_ID: ${{ env.SLACK_CLIENT_ID }}
    CLIENT_SECRET: ${{ env.SLACK_CLIENT_SECRET }}
    SIGNING_SECRET: ${{ env.SLACK_SIGNING_SECRET }}