Jump to Content
Dev Guide
User Guide
Dev Guide
Recommendations
Campaign
Configured Commerce
Content Management System
Content Marketing Platform
Customized Commerce
Digital Experience Platform
Experimentation Data
Feature Experimentation
Full Stack Experimentation
Optimizely Connect Platform
Optimizely Data Platform
Performance Edge
Web Experimentation
Integrations
Dev Guide
User Guide
GitHub
NuGet
DevCommunity
Doc feedback
Log In
GitHub
NuGet
DevCommunity
Doc feedback
Log In
Moon (Dark Mode)
Sun (Light Mode)
Optimizely Connect Platform
Search
Get Started with OCP
Get started with OCP
When to use OCP
Configure your development environment
Quickstart: Build an App
Overview
Scaffold the app and define the schema
Publish to the ODP sandbox
Configure and authenticate the app
Write a function
Write a job
Publish the app in ODP App Directory
Core Concepts
App structure
src/
forms/
assets/
app.yml
.env
Lifecycle
Jobs
Functions
Global functions
Channel apps
Campaign and channel events
Liquid extensions
Forms
Form basics
Layout
Form elements
Remote select options
Form validation
Process forms
Storage
Secrets store
Settings store
Key value store
Shared key value store
Schema for objects and fields
Schema modules
App logs and troubleshooting
Activity Log notifications
Test your app
OAuth authentication
Reference
ODP APIs
Add a dependency
Job cron expression
Batcher and CSV parser utilities
App SDK API REFERENCE
Overview
Classes
AuthorizationGrantResult
Batch
FunctionApiError
FunctionClassNotFoundError
JobApiError
JobNotFoundError
NumberSet
Message
StringSet
Batcher
CampaignEvents
Channel
ChannelContentResult
ChannelPreviewResult
ChannelTargetResult
Consumer
CsvStream
FileStream
FormResult
Function
GlobalFunction
Headers
Job
JsonLinesStream
Lifecycle
LifecycleSettingsResult
LiquidExtension
LiquidExtensionResult
LocalAsyncStoreBackend
Request
Response
Runtime
Enums
AttributableMetric
ChannelType
DeliveryMetric
DisengagementMetric
EngagementMetric
JobRunStatus
LogLevel
LogVisibility
ReachabilityMetric
Functions
getAppContext()
isGlobalContext()
resetLocalKvStore()
resetLocalSecretsStore()
resetLocalSettingsStore()
resetLocalSharedKvStore()
resetLocalStores()
setContext()
Interfaces
AppConsumer
AppContext
AppFunction
AppJob
AppLiquidExtension
AppManifest
BaseKVStore
Batch
CampaignContent
CampaignDelivery
CampaignTargeting
CampaignTracking
CanUninstallResult
ChannelDeliverOptions
ChannelDeliverResult
ChannelPrepareOptions
ChannelPrepareResult
ChannelPublishOptions
ChannelRateLimit
ChannelTemplatePreviewResult
ChannelValidateOptions
ConsumerResult
CsvRow
FileRowProcessor
FunctionApi
FunctionEndpoints
ILogger
JobApi
JobDefinition
JobDetail
JobInvocation
JobStatus
JsonLineRow
KVHash
KVRowOptions
KVStore
LifecycleResult
LiquidExtensionContext
LiquidExtensionInput
LoggerOptions
Message
MultiValue
Notifier
PreviewDisplayOptions
QueryParams
Queue
QueueMessage
SleepOptions
SubmittedFormData
ValueHash
Types
AppCategory
AppRuntime
BatchOperation
CampaignAction
CsvReadableStreamBuilder
CsvRowProcessor
FileReadableStreamBuilder
HttpMethod
Intent
JSONEncodable
JsonLineReadableStreamBuilder
KVPatchUpdater
KVValue
PatchUpdater
Value
Variables
APP_ID_FORMAT
DEFAULT_LOG_LEVEL
LOG_LEVELS
LOG_LEVELS_BY_STRING
VENDOR_FORMAT
VERSION_FORMAT
functions
jobs
logger
notifications
queue
storage
namespace: Form
clearDefaultSection()
getDefaultSection()
setDefaultSection()
NODE SDK API REFERENCE
Overview
Variables
z
namespace: Zaius
Zaius - Classes
ApiError
Zaius - Interfaces
ConsentUpdate
CreateIdentifierResponse
CustomerPayload
CustomerResponse
DataSource
EventData
EventPayload
EventResponse
FieldDefinition
GetConsentResponse
GetReachabilityResponse
IdentifierDefinition
IdentifierMetadata
IdentifierMetadataResponse
Identifiers
ModulesResponse
ObjectDefinition
ObjectPayload
ObjectResponse
PayloadOptions
ReachabilityUpdate
RelationDefinition
Zaius - Types
FieldValue
ReachabilityUpdateType
namespace: Zaius.ApiV3
Zaius.ApiV3 - Classes
HttpError
Zaius.ApiV3 - Enums
ErrorCode
Zaius.ApiV3 - Functions
configure()
errorForCode()
get()
post()
request()
Zaius.ApiV3 - Interfaces
HttpResponse
V3ErrorResponse
V3InvalidEventDetail
V3InvalidSchemaDetail
V3Response
V3SuccessResponse
Zaius.ApiV3 - Types
HttpMethod
Zaius.ApiV3 - Variables
BATCH_LIMIT
Release notes
2023 OCP release notes
Variables
Suggest Edits
Variables
z
Updated about 1 month ago
Table of Contents
Variables
