Jump to Content
Dev Guide
User Guides
Dev Guide
API Reference
Commerce Connect
Configured Commerce
Content Management System
Content Marketing Platform
Cross-platform products
Digital Experience Platform
Experimentation Data
Feature Experimentation
Optimizely Connect Platform
Optimizely Data Platform
Performance Edge
Recommendations
Web Experimentation
Campaign
Deprecated Products
Connect Platform for ODP
Optimizely Connect Platform
Dev Guide
User Guides
GitHub
Dev Community
Optimizely Academy
Submit a ticket
Log In
Dev Guide
GitHub
Dev Community
Optimizely Academy
Submit a ticket
Log In
Optimizely Connect Platform
Connect Platform for ODP
Dev Guide
ODP.ApiV3 - Classes
ODP.ApiV3 - Classes
All
Pages
Start typing to search…
Get Started with Connect Platform for ODP
Get started with OCP
When to use Connect Platform for ODP
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
Batcher and CSV parser utilities
Add a dependency
Job cron expression
App SDK API REFERENCE
Overview
Classes
Batch
Message
AuthorizationGrantResult
Batcher
CampaignEvents
Channel
ChannelContentResult
ChannelPreviewResult
ChannelTargetResult
CsvStream
Consumer
Destination
DestinationSchemaFunction
FileStream
FormResult
Function
FunctionApiError
FunctionClassNotFoundError
GlobalFunction
Headers
Job
JobApiError
JobNotFoundError
JsonLinesStream
Lifecycle
LifecycleSettingsResult
LiquidExtension
LiquidExtensionResult
LocalAsyncStoreBackend
NumberSet
Request
Response
Runtime
SourceError
SourceFunction
SourceJob
SourceLifecycle
SourceSchemaFunction
StringSet
Enums
AttributableMetric
ChannelType
DeliveryMetric
DisengagementMetric
EngagementMetric
JobRunStatus
LogLevel
LogVisibility
ReachabilityMetric
Functions
getAppContext
isGlobalContext
resetLocalKvStore
resetLocalSecretsStore
resetLocalSettingsStore
resetLocalSharedKvStore
resetLocalStores
setContext
Interfaces
AppConsumer
AppContext
AppDestination
AppDestinationSchemaFunction
AppFunction
AppJob
AppLiquidExtension
AppManifest
Batch
AppSource
AppSourceFunction
AppSourceJob
AppSourceLifecycle
AppSourceSchemaFunction
BaseKVStore
CampaignContent
CampaignDelivery
CampaignTargeting
CampaignTracking
CanUninstallResult
ChannelDeliverOptions
ChannelDeliverResult
ChannelPrepareOptions
ChannelPrepareResult
ChannelPublishOptions
ChannelRateLimit
ChannelTemplatePreviewResult
ChannelValidateOptions
ConsumerResult
CsvRow
DataSync
DestinationBatch
DestinationDeliverResult
DestinationField
DestinationReadyResult
DestinationSchema
DestinationSchemaField
DestinationSchemaFunctionConfig
DestinationSchemaObjects
DestinationSchemaResult
FileRowProcessor
FunctionApi
Message
FunctionEndpoints
GetDestinationSchemaResult
ILogger
JobApi
JobDefinition
Queue
JobDetail
QueueMessage
JobInvocation
JobStatus
JsonLineRow
KVHash
KVRowOptions
KVStore
LifecycleResult
SchemaField
LiquidExtensionContext
LiquidExtensionInput
LoggerOptions
MultiValue
Notifier
PreviewDisplayOptions
QueryParams
SleepOptions
Source
SourceCallbackResponse
SourceConfiguration
SourceData
SourceJobInvocation
SourceJobStatus
SourceResponse
SourceSchema
SourceSchemaField
SourceSchemaFunctionConfig
SourceSchemaObjects
SourceSleepOptions
SubmittedFormData
ValueHash
Types
AppCategory
AppRuntime
BatchOperation
CampaignAction
CsvReadableStreamBuilder
CsvRowProcessor
FileReadableStreamBuilder
HttpMethod
Intent
JsonLineReadableStreamBuilder
JSONEncodable
KVPatchUpdater
KVValue
PatchUpdater
SourceCreateResponse
SourceDeleteResponse
SourceEnableResponse
SourcePauseResponse
SourceUpdateResponse
Value
Variables
APP_ID_FORMAT
DEFAULT_LOG_LEVEL
LOG_LEVELS
LOG_LEVELS_BY_STRING
VENDOR_FORMAT
VERSION_FORMAT
functions
jobs
logger
notifications
storage
queue
namespace: Form
clearDefaultSection
getDefaultSection
setDefaultSection
NODE SDK API REFERENCE
Overview
Variables
odp
z
namespace: Zaius
namespace: ODP
Zaius - Classes
ApiError
ODP - Classes
ApiError
ApiFieldExistsError
ApiIdentifierExistsError
ApiModuleAlreadyEnabledError
ApiObjectExistsError
ApiObjectNotFoundError
ApiRelationExistsError
ApiSchemaValidationError
Zaius - Interfaces
ConsentUpdate
CreateIdentifierResponse
CustomerPayload
CustomerResponse
DataSource
EventData
EventPayload
EventResponse
FieldDefinition
GetConsentResponse
GetReachabilityResponse
IdentifierDefinition
IdentifierMetadata
IdentifierMetadataResponse
Identifiers
ModulesResponse
ObjectDefinition
ObjectPayload
ObjectResponse
PayloadOptions
ReachabilityUpdate
RelationDefinition
ODP - Interfaces
ConsentUpdate
CreateIdentifierResponse
CustomerPayload
CustomerResponse
DataSource
EventData
EventPayload
EventResponse
FieldDefinition
GetConsentResponse
GetReachabilityResponse
IdentifierDefinition
IdentifierMetadata
IdentifierMetadataResponse
Identifiers
ModulesResponse
ObjectDefinition
ObjectPayload
ObjectResponse
PayloadOptions
ReachabilityUpdate
RelationDefinition
Schema
Zaius - Types
FieldValue
ReachabilityUpdateType
ODP - Types
FieldValue
ReachabilityUpdateType
namespace: Zaius.ApiV3
namespace: ODP.ApiV3
Zaius.ApiV3 - Classes
HttpError
ODP.ApiV3 - Classes
API
HttpError
Zaius.ApiV3 - Enums
ErrorCode
ODP.ApiV3 - Enums
ErrorCode
Zaius.ApiV3 - Functions
configure()
errorForCode()
get()
post()
request()
Zaius.ApiV3 - Interfaces
HttpResponse
V3ErrorResponse
V3InvalidEventDetail
V3InvalidSchemaDetail
V3Response
V3SuccessResponse
ODP.ApiV3 - Interfaces
HttpResponse
RequestOptions
V3ErrorResponse
V3InvalidEventDetail
V3InvalidSchemaDetail
V3Response
V3SuccessResponse
Zaius.ApiV3 - Types
HttpMethod
ODP.ApiV3 - Types
HttpMethod
Payload
Zaius.ApiV3 - Variables
BATCH_LIMIT
ODP.ApiV3 - Variables
BATCH_LIMIT
Classes
ODPClient
ReconfigurableODPClient
Release notes
2023 Connect Platform for ODP release notes
HOW-TO GUIDES
Node22 migration guide
Powered by
ODP.ApiV3 - Classes
ODP.ApiV3 - Classes
API
HttpError
Updated 6 months ago
HttpError
API
Ask AI
