Brightspot CMS Developer Guide
Brightspot CMS Developer Guide
Developer guide
Content Delivery API

Custom Content Delivery API development

Overview of custom CDA development
For stable production functionality, it typically makes more sense to build a custom Content Delivery endpoint via code, rather than entirely through editorial configuration. An endpoint class can ensure that a fixed set of APIs are exposed with configuration that should not change between different environments.

Implementing custom CDAs

  1. Create a new Java class extending ContentDeliveryApiEndpoint.
  2. Implement required methods:

  • getPathSuffix—appended to /graphql/delivery/ to create the path where the API endpoint is available.
  • getQueryEntryFields—objects wrapping view model and interface classes used to generate the schema and expose APIs.


public class FooContentDeliveryApiEndpoint extends ContentDeliveryApiEndpoint {

    protected String getPathSuffix() {
        return "foo"; // API endpoint is available at path '/graphql/delivery/foo'

    public List<ContentDeliveryEntryPointField> getQueryEntryFields() {
        return Arrays.asList(
               new ContentDeliveryEntryPointField(FooViewModel.class),
               new ContentDeliveryEntryPointField(BarViewModel.class));

Previous Topic
CDA guides
Next Topic
Using Brightspot GraphQL Preview
Was this topic helpful?
Thanks for your feedback.
Our robust, flexible Design System provides hundreds of pre-built components you can use to build the presentation layer of your dreams.

Asset types
Module types
Page types
Brightspot is packaged with content types that get you up and running in a matter of days, including assets, modules and landing pages.

Content types
Landing pages
Everything you need to know when creating, managing, and administering content within Brightspot CMS.

Admin configurations
A guide for installing, supporting, extending, modifying and administering code on the Brightspot platform.

Field types
Content modeling
Rich-text elements
A guide to configuring Brightspot's library of integrations, including pre-built options and developer-configured extensions.

Google Analytics
Apple News