Add a Schema
This guide covers creating a new schema in MonetizationOS.
Adding a Schema
To add a new schema, navigate to the Schemas section from the left-hand navigation menu and click 'Add Schema'.
A modal will open asking you to choose a schema purpose. The available options are:
- App Experience: For schema-driven components rendered by your own frontend library
- Offer Presentation: Defines how an individual offer is displayed within an experience
- Offer Redemption: Defines the information required to redeem an offer
Select the relevant option, then click 'Next'.
Configure
You will be taken to the Configure screen. You will be prompted to give your schema a name, slug, and optional description. By default, the slug will be a hyphenated version of the name you give the schema, but you can override this if you wish.
Once complete, click 'Next'.
Offer Support
If you selected App Experience, you will be prompted to configure offer support before your schema is created.
Enable this if your experience displays offers — such as subscription plans or pricing options — alongside your content fields. When enabled, you can select an Offer Presentation schema to determine which offers can be attached to the experience when configuring them in the experience editor.
To enable offer support, toggle the switch to 'Yes'. A dropdown will appear allowing you to select the relevant Offer Presentation schema.
Please note: Offer support can only be configured at this stage. If you need to change this setting, you will need to create a new schema.
Once you have completed the configuration, click 'Create Schema'.
Schema Editor
After creating your schema, you will be taken to the schema editor. The editor is broken into two tabs: Schema and Manage.
Schema
The Schema tab provides the configuration area where you define the fields and structure of your schema. You can build this manually or use the MonetizationOS assistant to help generate the schema for you. Once you have made the appropriate changes, click 'Save'.
Manage
The Manage tab allows you to update the name and description of your schema, or delete it. For more information, see the Manage a Schema guide.