For AI agents: visit https://docs.developers.optimizely.com/optimizely-connect-platform/v1.0/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Dev Guide User Guides

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

Functions

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
Lifecycle
Jobs
Functions
Global functions
Channel apps
- Campaign and channel events
- Liquid extensions
Forms
Storage
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
Enums
Functions
Interfaces
Types
Variables
namespace: Form

NODE SDK API REFERENCE

Overview
Variables
- odp
- z
namespace: Zaius
namespace: ODP
Zaius - Classes
- ApiError
ODP - Classes
Zaius - Interfaces
ODP - Interfaces
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
Zaius.ApiV3 - Interfaces
ODP.ApiV3 - Interfaces
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

Functions

Functions

getAppContext
isGlobalContext
resetLocalKvStore
resetLocalSecretsStore
resetLocalSettingsStore
resetLocalSharedKvStore
resetLocalStores
setContext

Updated 2 months ago

ReachabilityMetric

Did this page help you?

- Functions

System Status
Privacy Notice
Website Terms of Use
Cookie Settings
Trust Center
Third-Party Addons & Platforms
API, SDK, & MCP Terms