JSON Field

Shows a JSON field in the Payload Admin Panel
Admin Panel screenshot of a JSON field

This field uses the monaco-react editor syntax highlighting.

Config

OptionDescription
name *To be used as the property name when stored and retrieved from the database. More
labelText used as a field label in the Admin Panel or an object with keys for each language.
uniqueEnforce that each entry in the Collection has a unique value for this field.
indexBuild an index for this field to produce faster queries. Set this field to true if your users will perform queries on this field's data often.
validateProvide a custom validation function that will be executed on both the Admin Panel and the backend. More
jsonSchemaProvide a JSON schema that will be used for validation. JSON schemas
saveToJWTIf this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.
hooksProvide Field Hooks to control logic for this field. More details.
accessProvide Field Access Control to denote what users can see and do with this field's data. More details.
hiddenRestrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel.
defaultValueProvide data to be used for this field's default value. More
localizedEnable localization for this field. Requires localization to be enabled in the Base config.
requiredRequire this field to have a value.
adminAdmin-specific configuration. See below for more detail.
customExtension point for adding custom data (e.g. for plugins)
typescriptSchemaOverride field type generation with providing a JSON schema

* An asterisk denotes that a property is required.

Admin Config

In addition to the default field admin config, you can adjust the following properties:

OptionDescription
editorOptionsOptions that can be passed to the monaco editor, view the full list.

Example

collections/ExampleCollection.ts

1
import { CollectionConfig } from 'payload'
2
3
export const ExampleCollection: CollectionConfig = {
4
slug: 'example-collection',
5
fields: [
6
{
7
name: 'customerJSON', // required
8
type: 'json', // required
9
required: true,
10
},
11
],
12
}

JSON Schema Validation

Payload JSON fields fully support the JSON schema standard. By providing a schema in your field config, the editor will be guided in the admin UI, getting typeahead for properties and their formats automatically. When the document is saved, the default validation will prevent saving any invalid data in the field according to the schema in your config.

If you only provide a URL to a schema, Payload will fetch the desired schema if it is publicly available. If not, it is recommended to add the schema directly to your config or import it from another file so that it can be implemented consistently in your project.

Local JSON Schema

collections/ExampleCollection.ts

1
import { CollectionConfig } from 'payload'
2
3
export const ExampleCollection: CollectionConfig = {
4
slug: 'example-collection',
5
fields: [
6
{
7
name: 'customerJSON', // required
8
type: 'json', // required
9
jsonSchema: {
10
uri: 'a://b/foo.json', // required
11
fileMatch: ['a://b/foo.json'], // required
12
schema: {
13
type: 'object',
14
properties: {
15
foo: {
16
enum: ['bar', 'foobar'],
17
}
18
},
19
},
20
},
21
22
},
23
],
24
}
25
// {"foo": "bar"} or {"foo": "foobar"} - ok
26
// Attempting to create {"foo": "not-bar"} will throw an error

Remote JSON Schema

collections/ExampleCollection.ts

1
import { CollectionConfig } from 'payload'
2
3
export const ExampleCollection: CollectionConfig = {
4
slug: 'example-collection',
5
fields: [
6
{
7
name: 'customerJSON', // required
8
type: 'json', // required
9
jsonSchema: {
10
uri: 'https://example.com/customer.schema.json', // required
11
fileMatch: ['https://example.com/customer.schema.json'], // required
12
},
13
},
14
],
15
}
16
// If 'https://example.com/customer.schema.json' has a JSON schema
17
// {"foo": "bar"} or {"foo": "foobar"} - ok
18
// Attempting to create {"foo": "not-bar"} will throw an error
Next

Collapsible Field