For AI agents: the docs index is at https://docs.helloteak.com/v2.0/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Teak API
GuidesReference EndpointsChangelog
Teak API
Guides
Introduction

Implementation Guide

  • Introduction
  • 1. Setup & Configuration
  • 2. Affiliate Authentication
    • Affiliate Authentication Guide
  • 3. Setting Up Clients
    • Setting Up Clients Guide
  • 4. Implement the Widget
    • Implement the Widget Guide
      • Adding the JavaScript Library
      • Adding the HTML Placeholder
      • Minimal Rendering and Validation
      • Listening to Lifecycle Events
      • Configuration Options
      • Updating the Widget
      • Handling Taxes & Fees
      • Helper Methods
      • Finished Code Example
  • 5. Submitting Orders
    • Submitting Orders Guide
      • Adding the Quote Token
      • Adding Order Details
      • Adding Customer Info and Billing Address
      • Adding Items
      • Adding Payment Info
      • Putting It All Together (Opt-In)
      • Putting It All Together (Opt-Out)
  • 6. Notifications
    • Using the Webhook Signature
    • Contract Void - Required
      • Contract Void Guide
    • Contract Canceled - Optional
      • Contract Canceled Guide
    • Contract Issued - Optional
      • Contract Issued Guide
    • Contract On Hold - Optional
      • Contract On Hold Guide
    • Contract Downgraded - *Required
      • Contract Downgraded
    • Contract Upgraded - Optional
      • Contract Upgraded
    • Contract Exchanged - Optional
      • Contract Exchanged
    • Refund Request Approved - Optional
      • Refund Request Approved Guide
    • Refund Request Created - Optional
      • Refund Request Created Guide
    • Refund Request Denied - Optional
      • Refund Request Denied Guide
    • Refund Request Pending Consumer - Optional
      • Refund Request Pending Consumer Guide
    • Refund Request Pending Documents - Optional
      • Refund Request Pending Documents Guide
    • Refund Request Pending Document Review - Optional
      • Refund Request Pending Document Review Guide
    • Refund Request Pending Agent Review - Optional
      • Refund Request Pending Agent Review Guide
    • Refund Request Pending ID Verification - Optional
      • Refund Request Pending ID Verification Guide

Additional Documentation

  • Decoding/Validating the Quote
  • Policy Changes
    • Policy Void
    • Policy Cancel
    • Policy Upgrade/Downgrade/Exchange
  • Order Metadata

Introduction

The following guide will help you and your team work through implementing the Teak product.


  1. Setup & Configuration
  2. Affiliate Authentication
  3. Setting Up Clients
  4. Implementing the widget
  5. Submitting Orders
  6. Notifications

Updated about 1 year ago


1. Setup & Configuration
Did this page help you?