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

# List Source Types

> Webhook types a source can be, with the credentials and settings each needs.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/workspaces/{workspace}/streams/source-types
openapi: 3.1.0
info:
  description: >-
    Modular and extensible framework for building AI agents. This API requires
    JWT Bearer token authentication for most endpoints. Include your JWT token
    in the Authorization header. Public endpoints include /, /health, /docs,
    /redoc, and /openapi.json.
  title: AgentArea API
  version: 0.1.0
servers: []
security:
  - bearer: []
paths:
  /v1/workspaces/{workspace}/streams/source-types:
    get:
      tags:
        - v1
        - protected
        - streams
      summary: List Source Types
      description: >-
        Webhook types a source can be, with the credentials and settings each
        needs.
      operationId: list_source_types_v1_streams_source_types_get
      parameters:
        - description: Slug of the workspace the request acts in
          in: path
          name: workspace
          required: true
          schema:
            description: Slug of the workspace the request acts in
            maxLength: 120
            pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
            title: Workspace
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/StreamSourceTypeResponse'
                title: Response List Source Types V1 Streams Source Types Get
                type: array
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    StreamSourceTypeResponse:
      properties:
        config:
          description: Plain settings.
          items:
            $ref: '#/components/schemas/SourceField'
          title: Config
          type: array
        credentials:
          description: 'Secret fields: write-only, held by reference, never returned.'
          items:
            $ref: '#/components/schemas/SourceField'
          title: Credentials
          type: array
        description:
          title: Description
          type: string
        events:
          description: Event kinds it can deliver.
          items:
            type: string
          title: Events
          type: array
        icon:
          title: Icon
          type: string
        icon_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Icon Url
        name:
          title: Name
          type: string
        verification:
          description: >-
            signature: the body is signed with the secret; secret_token: the
            sender repeats a token; api_lookup: the notified object is read back
            from the API.
          enum:
            - signature
            - secret_token
            - api_lookup
          title: Verification
          type: string
        webhook_type:
          title: Webhook Type
          type: string
      required:
        - webhook_type
        - name
        - description
        - icon
        - verification
        - credentials
        - icon_url
      title: StreamSourceTypeResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    SourceField:
      properties:
        key:
          title: Key
          type: string
        label:
          title: Label
          type: string
        placeholder:
          default: ''
          title: Placeholder
          type: string
        required:
          default: true
          title: Required
          type: boolean
      required:
        - key
        - label
      title: SourceField
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      description: JWT Bearer token for authentication
      scheme: bearer
      type: http
    HTTPBearer:
      scheme: bearer
      type: http

````

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