OCP App SDK

---

OCP App SDK / AppManifest

Interface: AppManifest

Defined in: src/app/types/AppManifest.ts:159

Properties

channel?

optional channel: object

Defined in: src/app/types/AppManifest.ts:191

delivery?

optional delivery: object

delivery.batch_size?

optional batch_size: number

delivery.concurrent_batches?

optional concurrent_batches: number

delivery.rate_limits?

optional rate_limits: ChannelRateLimit[]

metrics?

optional metrics: object

metrics.attributable?

optional attributable: AttributableMetric[]

metrics.delivery?

optional delivery: DeliveryMetric[]

metrics.disengagement?

optional disengagement: DisengagementMetric[]

metrics.engagement?

optional engagement: EngagementMetric[]

metrics.reachability?

optional reachability: ReachabilityMetric[]

options?

optional options: object

options.prepare?

optional prepare: boolean

options.template_preview?

optional template_preview: boolean

targeting

targeting: CampaignTargeting[] | "dynamic"

type

type: ChannelType

---

consumers?

optional consumers: object

Defined in: src/app/types/AppManifest.ts:179

Index Signature

[name: string]: AppConsumer

---

destinations?

optional destinations: object

Defined in: src/app/types/AppManifest.ts:185

Index Signature

[name: string]: AppDestination

---

environment?

optional environment: string[]

Defined in: src/app/types/AppManifest.ts:172

---

functions?

optional functions: object

Defined in: src/app/types/AppManifest.ts:173

Index Signature

[name: string]: AppFunction

---

jobs?

optional jobs: object

Defined in: src/app/types/AppManifest.ts:176

Index Signature

[name: string]: AppJob

---

liquid_extensions?

optional liquid_extensions: object

Defined in: src/app/types/AppManifest.ts:182

Index Signature

[name: string]: AppLiquidExtension

---

meta

meta: object

Defined in: src/app/types/AppManifest.ts:160

app_id

app_id: string

availability

availability: string[]

categories

categories: AppCategory[]

contact_email

contact_email: string

display_name

display_name: string

summary

summary: string

support_url

support_url: string

vendor

vendor: string

version

version: string

---

outbound_domains?

optional outbound_domains: string[]

Defined in: src/app/types/AppManifest.ts:211

---

runtime

runtime: AppRuntime

Defined in: src/app/types/AppManifest.ts:171

---

sources?

optional sources: object

Defined in: src/app/types/AppManifest.ts:188

Index Signature

[name: string]: AppSource