> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Save Slack App

> Register or change the app every organization installs.



## OpenAPI

````yaml https://platform.tracecat.com/api/openapi.json put /admin/slack-app
openapi: 3.1.0
info:
  title: Tracecat API
  summary: Tracecat API
  description: The open source AI automation platform for security teams and agents.
  termsOfService: >-
    https://docs.google.com/document/d/e/2PACX-1vQvDe3SoVAPoQc51MgfGCP71IqFYX_rMVEde8zC4qmBCec5f8PLKQRdxa6tsUABT8gWAR9J-EVs2CrQ/pub
  contact:
    name: Tracecat Founders
    email: founders@tracecat.com
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
  version: '1'
servers:
  - url: /api
security: []
tags:
  - name: public
    description: Public facing endpoints
  - name: workflows
    description: Workflow management
  - name: actions
    description: Action management
  - name: triggers
    description: Workflow triggers
  - name: secrets
    description: Secret management
  - name: variables
    description: Workspace variable management
paths:
  /admin/slack-app:
    put:
      tags:
        - admin:slack-app
      summary: Save Slack App
      description: Register or change the app every organization installs.
      operationId: admin:slack-app-save_slack_app
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SlackPlatformAppUpdate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackPlatformAppRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyCookie: []
components:
  schemas:
    SlackPlatformAppUpdate:
      properties:
        app_id:
          type: string
          minLength: 1
          title: App Id
        client_id:
          type: string
          minLength: 1
          title: Client Id
        client_secret:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
          title: Client Secret
        signing_secret:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
          title: Signing Secret
        app_token:
          anyOf:
            - type: string
              pattern: ^(xoxe\.)?xapp-.+
            - type: 'null'
          title: App Token
          description: >-
            App-level token (`xapp-`, or rotating `xoxe.xapp-`) with
            connections:write. Required when the deployment receives Slack
            events over Socket Mode.
        app_refresh_token:
          anyOf:
            - type: string
              pattern: ^xoxe-.+
            - type: 'null'
          title: App Refresh Token
          description: >-
            The refresh token Slack shows once beside a rotating `xoxe.xapp-`
            app-level token. Required with one; rejected otherwise.
      additionalProperties: false
      type: object
      required:
        - app_id
        - client_id
      title: SlackPlatformAppUpdate
      description: >-
        Register or change the app. An omitted secret keeps its stored value
        while the

        app ID stays the same.
    SlackPlatformAppRead:
      properties:
        app_id:
          anyOf:
            - type: string
            - type: 'null'
          title: App Id
        client_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Client Id
        client_secret_set:
          type: boolean
          title: Client Secret Set
        signing_secret_set:
          type: boolean
          title: Signing Secret Set
        app_token_set:
          type: boolean
          title: App Token Set
        icon_uploaded:
          type: boolean
          title: Icon Uploaded
        distribution_enabled:
          type: boolean
          title: Distribution Enabled
        unreadable:
          type: boolean
          title: Unreadable
        setup:
          $ref: '#/components/schemas/ChannelBotPlatformAppSetup'
      type: object
      required:
        - app_id
        - client_id
        - client_secret_set
        - signing_secret_set
        - app_token_set
        - icon_uploaded
        - distribution_enabled
        - unreadable
        - setup
      title: SlackPlatformAppRead
      description: The registration without its secrets, and what to paste into Slack.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ChannelBotPlatformAppSetup:
      properties:
        transport:
          $ref: '#/components/schemas/ChannelBotTransport'
        oauth_redirect_url:
          type: string
          title: Oauth Redirect Url
        request_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Url
      type: object
      required:
        - transport
        - oauth_redirect_url
        - request_url
      title: ChannelBotPlatformAppSetup
      description: What a platform admin pastes into the deployment's own provider app.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ChannelBotTransport:
      type: string
      enum:
        - http
        - socket
      title: ChannelBotTransport
      description: >-
        How a bot's events arrive: posted to our endpoint, or read from a
        provider socket.
  securitySchemes:
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: fastapiusersauth

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.