Skip to content
EdgeKit
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Menu
Get started
Checklist
Getting started FAQ
Revenue
Overview
Paywall
Overview
Create and edit a feature
Create an outcome
Set up a meter
Ask for a decision
Gift links
Paywall FAQ
Troubleshooting
Subscriptions
Overview
Set up a product
Create and sell an offer
Register a capability
Sell an offer with checkout
How access follows your billing provider
Read your billing provider's records
Subscriptions FAQ
Shared
Overview
Segments
Experiments
Facts
Observability
Shared FAQ
Identity
Overview
EdgeKit ID
Overview
Sign users in
Sessions and sign-out
Let users manage their account
Ask users about themselves
Choose who signs users in
Connect your existing login
Move users off your existing login
Let members run their user organization
EdgeKit ID FAQ
Troubleshooting
Profile
Overview
Define a profile field
Send your own scores
Record consent
Profile FAQ
Shared
Overview
Users
User organizations
Grants
Observability
Users, user organizations and grants FAQ
Delivery
Overview
Sites
Overview
Change a site's settings
Issue and revoke API keys
Select a site on a request
Site settings
Sites FAQ
Versions
Overview
Stage and deploy a change
Undo a change
Versions FAQ
First-party mount and proxy
Overview
Mount /edgekit/ on your domain
Call the tenant host directly
Run the site proxy
Verify the mount
First-party mount FAQ
Troubleshooting
Reference
API
Tenant
Overview
ID
Overview
Read the ID configuration for a site
Read the traits a site collects
Send a magic link
Consume a magic-link token
Send a sign-in code
Sign in with a code
Sign in with a Google ID token
Read the current user session
Exchange an upstream credential for an EdgeKit session
Sign out
Request an identifier change
Confirm an identifier change
Read the signed-in user
Update the signed-in user
The upstream deleted this person
The upstream locked this account or reset its password
The upstream changed this person's address
The upstream subject itself moved
Checkout
Overview
Buy an offer the decision engine offered
Newsletters
Overview
The newsletters this site offers
Where one person stands on every list
Replace one person’s standing on this site
The newsletter confirmation interstitial
Confirm a pending newsletter subscription
The unsubscribe page
Unsubscribe through an edition’s link
Recommendations
Overview
Recommend items for a user or device
Organizations
Overview
List the organizations the user belongs to
Set the active organization
Rename an organization
Read the user’s own membership
List the organization’s members
Change a member’s role
Remove a member
Leave an organization
Invite someone to an organization
Cancel a pending invitation
List an organization’s pending invitations
Read one invitation
List the user’s own pending invitations
Accept an invitation
List people refused a seat
Reject an invitation
Analytics
Overview
List every deployed schema URI
Resolve a schema
Streaming
Overview
Send a batch of the organization's own scores
System
Overview
Healthcheck
Grants
List the signed-in user’s grants
Content
Re-read changed items from the CMS
Publications
A publication’s public archive index
Decide
Overview
Decide
Overview
Decide a batch of features (API key)
Evaluate a journey feature and redirect
Decide a batch of features (browser)
Gift links
Overview
Create a gift link (API key)
Create a gift link (browser)
Interventions
Overview
Subscribe to interventions
Error codes
CLI
SDKs
@edgekitcloud/client-browser
Classes
EdgeKitConfigError
Type Aliases
BrowserClientOptions
BrowserDecideOptions
CallResult
CheckoutOptions
CheckoutRequestBody
CheckoutResponseBody
CreateGiftLinkResponseBody
DecidedFeature
DecideResults
DecisionsSchema
EdgeKitSession
ExternalSession
FailedCall
FeatureNameOf
FeatureResult
FeatureSchema
GiftLinkOptions
GiftLinkStatus
Grant
GrantsOptions
GrantsResponseBody
GrantState
IdConfig
IdMethod
IdMode
IdTraitConstraints
IdTraitDescriptor
IdUser
NewsletterList
NewsletterListsResponseBody
NewsletterOptions
NewsletterSubscription
NewsletterSubscriptionsResponseBody
NewsletterSubscriptionStatus
Ok
OkResult
Organization
OrgInvitation
OrgMember
OrgSeatRefusal
OutcomeSchema
OutcomeType
SessionListener
SessionRef
SessionState
SignInResult
SignOutResult
SiteSchema
SubscriptionsInput
TraitPatch
TraitValues
TraitValuesOf
UnavailableCall
UnavailableFeature
UnknownFeature
UnresolvedOutcome
UserDetails
UserDetailsInput
Variables
UNRESOLVED_OUTCOME
Functions
createClient
@edgekitcloud/client-server
Classes
EdgeKitConfigError
Type Aliases
DecidedFeature
DecideResults
DecisionsSchema
FeatureNameOf
FeatureResult
FeatureSchema
OutcomeSchema
OutcomeType
ServerClientOptions
ServerDecideOptions
SiteSchema
UnavailableFeature
UnknownFeature
UnresolvedOutcome
Variables
UNRESOLVED_OUTCOME
Functions
createServerClient
@edgekitcloud/analytics-browser
Type Aliases
EdgeKitTracker
EdgeKitTrackerOptions
Functions
createTracker
@edgekitcloud/proxy
Type Aliases
ConfigIssue
ConfigOutcome
ContentFacts
DecisionIsland
ProxyAdapter
ProxyConfig
ProxyElement
ProxyElementHandlers
ProxyMode
ProxyRewriter
ProxyWarning
RewritePlan
Variables
MOUNT_PREFIX
SCRIPT_PATH
Functions
createProxy
readConfig
Select theme
Dark
Light
Auto
Overview
Gift links
Section titled “Gift links”
Creating a gift link: one decision on the gift-link create feature, then a token when it allows.
Operations
Section titled “Operations”
POST
/v1/gift-links
POST
/edgekit/v1/gift-links