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

Types

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
Lifecycle
Jobs
Functions
Global functions
Channel apps
- Liquid extensions
- Campaign and channel events
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 OCP release notes

Types

Types

AppCategory
AppRuntime
BatchOperation
CampaignAction
CsvReadableStreamBuilder
CsvRowProcessor
FileReadableStreamBuilder
HttpMethod
Intent
JsonLineReadableStreamBuilder
KVPatchUpdater
KVValue
PatchUpdater
Value

Updated 6 months ago

Table of Contents
- Types

Privacy Notice
Website Terms of Use
Cookie Settings
Trust Center
Third-Party Addons & Platforms