ConfigExtract

The declarative configuration uploaded by portal deploy.

  • channels
    Type: object
    required

    Channel configs, keyed by channel id (exact id or * template; most-specific wins).

    • propertyName
      Type: object · ChannelConfig
      • anonymous
        Type: boolean
        required

        Whether anonymous users may connect.

      • extensions
        Type: object
        required

        Extensions attached to this channel, keyed by handle. Namespaces must be exclusive within a channel.

      • hooks
        Type: object · HooksManifest
        required

        What hooks a channel's config references (capabilities only, never code).

      • mode
        Type: string enum
        required

        Channel mode. standard has a roster and presence; broadcast does not.

        values
        • standard
        • broadcast
  • project
    Type: object
    required
    • webhooks
      Type: object · WebhookConfignullable
      required

      Webhook delivery configuration set via the webhooks field of portal.config.ts. When set, Portal relays message.published and message.retracted events for every channel to the given endpoint, signed with a per-environment secret (see GET /v1/webhooks/secret). null (the default) disables webhook delivery.

    • auth
      Type: object · ProjectAuthConfignullable

      Optional external auth config. null uses Portal-minted JWTs.

  • version
    Type: string
    required

    The config format version.