Ketch Web SDK

aid: ketch-com:ketch-web-sdk
name: Ketch Web SDK
description: 'TypeScript and JavaScript Web API and consent library for collecting, storing, and enforcing

  consent in browser environments. Includes the ketch-web-api client, the ketch-consent library,

  a typed ketch-types package, ketch-data-layer, and ketch-logging. Distributed across the

  github.com/ketch-sdk org.

  '
humanURL: https://github.com/ketch-sdk
tags:
- Web
- JavaScript
- TypeScript
- SDK
- Consent
properties:
- type: SourceCode
  url: https://github.com/ketch-sdk/ketch-web-api
- type: ConsentLibrary
  url: https://github.com/ketch-sdk/ketch-consent
- type: SourceCode
  url: https://github.com/ketch-sdk/ketch-types
- type: SourceCode
  url: https://github.com/ketch-sdk/ketch-data-layer
- type: SourceCode
  url: https://github.com/ketch-sdk/ketch-logging
- type: Documentation
  url: https://docs.ketch.com/
features:
- name: Bootstrap Configuration
  description: Fetch and apply per-property consent configuration at page load.
- name: Consent Retrieval
  description: Read current consent state for the visitor across categories and purposes.
- name: Branded Consent Experiences
  description: Render branded consent UIs that match site theming via the ketch-consent library.
- name: Data Layer
  description: ketch-data-layer normalizes events between Ketch and analytics platforms.
useCases:
- name: Web Cookie Consent
  description: Power compliant cookie banners and preference centers on web properties.
- name: Tag Firing Control
  description: Gate analytics and marketing tags based on visitor consent.
- name: Server-Side Forwarding
  description: Pair the Web SDK with an event forwarder to relay consented events to downstream systems.
integrations:
- name: Google Tag Manager
- name: Tealium
- name: Segment
- name: Adobe Analytics
authentication:
- type: Property Code
  description: Web SDK is configured per Ketch property using a property code rather than a secret API
    key.