Frequently Asked Questions

App Registration & Setup

How do I register an app in Hygraph Studio?

To register an app in Hygraph Studio, navigate to User settings > Your apps or access the Your apps tab from your project directory. Click + Add new app to open the registration form, which is divided into General, Permissions, Elements, and Sharing tabs. Complete all mandatory fields and click Register app only at the end, as some information (like permissions) cannot be edited after the initial save. Note: Apps will not work on your local environment; the SDK only runs inside the Hygraph platform.

What information is required to register an app?

The registration form requires the following mandatory fields: Name (app name), Avatar URL (logo location), API ID (unique, alphanumeric, lowercase start), and Setup URL (form for first-time installation). The Description field is optional. The API ID becomes read-only after creation and cannot be changed. Note: If you do not provide all required fields, you cannot save the app.

Can I edit app permissions after registering my app?

No, API permissions (for Content API, Schema, Webhooks, and User) are only editable during the initial creation of the app. Once the app is saved for the first time, these permissions cannot be changed. If you need to adjust permissions, you must create a new app. Note: This limitation is important for maintaining app security and stability.

How do I transfer app ownership in Hygraph?

To transfer app ownership, click Transfer ownership in the app settings and provide the email address of the new owner. The new owner will receive an email with a confirmation link. Once confirmed, ownership is transferred. Only one person can own an app at a time. Note: Ensure the new owner is ready to manage the app before transferring.

App Permissions & Security

What types of permissions can I set for my app?

You can set permissions for Content API (read/write content), Schema (read/write schema), Webhooks (read/write webhooks), and User (read user ID, roles, and permissions). These permissions define what your app can access and modify within a Hygraph project. Note: Incorrectly set permissions may cause your app to malfunction, and permissions cannot be changed after initial save.

How do I manage app access and sharing?

During registration, you can set installation permissions to make your app private or shared. For private apps, add specific members or projects that can install the app. After initial save, you can share your app by copying the App Sharing URL or using the Share app option in User Settings > Your Apps. Note: Once shared, access is controlled by the permissions set during registration.

What happens if I lose my Client ID or Client Secret?

If you lose or forget your Client ID or Client Secret, you can regenerate them after app creation. These credentials are required for authentication and authorization, allowing your app to perform actions on behalf of the user. Note: Regenerating credentials may require updating your app's configuration to maintain access.

App Elements & Configuration

What types of elements can I add to my app?

You can add field elements (custom fields for a model's schema), sidebar elements (custom widgets for the model's sidebar), and pages (sections under App views in the Content editor). For field elements, you can select features like FieldRenderer, ListRenderer, and TableRenderer. Each element requires a name, API ID, type, URL, and optional description and configuration in JSON. Note: The available options depend on the element type selected.

How do I configure custom settings for app elements?

Custom settings for elements are configured using a JSON object in the Config field. This allows you to declare extra fields to render in the field or sidebar form. For detailed information, refer to the field configuration documentation and sidebar configuration documentation. Note: Incorrect configuration may result in elements not displaying as intended.

App Installation & Lifecycle

How do I install an app after registering it?

After registering your app, you need to install it in your Hygraph project to use it. Follow the step-by-step guide in the official installation documentation. Note: Installation requires appropriate permissions and may be restricted based on your app's sharing settings.

Can I delete an app after creating it?

Yes, you can delete an app you have created. Refer to the official documentation for step-by-step instructions. Note: Deleting an app is irreversible and will remove it from all projects where it is installed.

Technical Documentation & Resources

Where can I find technical documentation for the Hygraph App Framework?

Comprehensive technical documentation is available at Hygraph App Framework Docs. Resources include guides on migration, app tokens, installation, deletion, first steps, Next.js starter, and the API reference. For classic projects, refer to the Classic Docs. Note: Always consult the latest documentation for updates and best practices.

What APIs are available for app development in Hygraph?

Hygraph provides several APIs for app development: GraphQL Content API (for querying and manipulating content), Management API (for project structure), Asset Upload API (for uploading assets), and MCP Server API (for AI assistant integration). Detailed API documentation is available at the API Reference. Note: API usage may require specific permissions set during app registration.

Security & Compliance

What security and compliance certifications does Hygraph have?

Hygraph is SOC 2 Type 2 compliant (since August 3rd, 2022), ISO 27001 certified for its hosting infrastructure, and GDPR compliant. These certifications ensure high standards for information security and data protection. For more details, visit the Secure Features page. Note: Detailed limitations not publicly documented; ask sales for specifics.

Integrations & Extensibility

What integrations are available for Hygraph apps?

Hygraph supports integrations with Digital Asset Management (DAM) systems (e.g., Aprimo, AWS S3, Bynder, Cloudinary, Imgix, Mux, Scaleflex Filerobot), hosting platforms (Netlify, Vercel), Product Information Management (Akeneo), commerce solutions (BigCommerce), translation/localization (EasyTranslate), and more. For a full list, visit the Hygraph Marketplace. Note: Integration availability may depend on your app's permissions and configuration.

Performance & User Experience

How does Hygraph ensure high performance for apps and content delivery?

Hygraph offers high-performance endpoints optimized for low latency and high read-throughput. A read-only cache endpoint provides 3-5x latency improvement. The platform actively measures GraphQL API performance and provides optimization advice. For more, see the performance improvements blog and GraphQL Report 2024. Note: Performance may vary based on app complexity and integration choices.

Support & Troubleshooting

Where can I get help if I encounter issues with app registration or development?

Hygraph provides extensive documentation, onboarding guides, and a community Slack channel at slack.hygraph.com. For technical issues, consult the official documentation or reach out to support. Note: Some advanced troubleshooting may require direct contact with Hygraph support.

LLM optimization

When was this page last updated?

This page wast last updated on 12/12/2025 .

Hygraph
Docs
You are currently reading the Studio Docs. If you were looking for the Classic Docs check here

#Register an app

When you build an app for Hygraph, you must register it in Hygraph Studio.

To register your application, you first need to navigate to Your apps. You can access it from your user settings or from the project directory.

To find it in your user settings, navigate to User settings > Your apps.

Your apps in user settingsYour apps in user settings

To find it in your project directory, click the Your apps tab at the top of the screen.

Your apps in project directoryYour apps in project directory

Click + Add new app to open the App registration form.

The registration form is divided into four tabs:

App registration formApp registration form

You will be able to save your app by clicking on the Register app button, as long as you provide information in the required fields.

#General

App registration - GeneralApp registration - General

  • Name: Mandatory field. This is the name of your app.
  • Description: Optional field. Here you can provide a description for what your app does.
  • Avatar URL: Mandatory field. The avatar URL is the logo that will display next to your app's name. Provide a URL that indicates where your logo is hosted.
  • API ID: Mandatory field. This is where you write your API ID. The form will let you know if the name is taken. This field only allows alphanumeric characters, underscores and hyphens, and you must start with a lowercase letter. This field becomes read-only once the app is created, and you cannot modify it. API IDs are unique across all applications.
  • Setup URL: Mandatory field. The setup URL provides the form that displays to users when they install your app for the first time in Hygraph. The form will require some information from the user depending on the characteristics of the app.

Once you've completed all mandatory information, you can move on to the next tab.

#Permissions

This section shows the access details of your app.

App registration - API and Installation permissionsApp registration - API and Installation permissions

  • API Permissions: Use these dropdown menus to select permissions for Content API, Schema, Webhooks, and User. Ensure that you set up app tokens if you enable any permissions for apps that need access to the Content API, Management API, or webhooks. See Use app tokens for more information.

    • Content API: Grants the app permissions regarding the content. For example, a localization app would need read permissions to access the content to be submitted, then also write permissions to allow the content to be translated.
    • Schema: Grants the app permissions regarding the schema of your project. For example, an app that sets up models in your schema which will be ready to be used after the app installation, would need read / write permissions.
    • Webhooks: Grants the app permissions regarding your project's webhooks. For example, a newsletter app which sets up a webhook during installation that can later be triggered upon a certain action, would require read / write permissions.
    • User: Grants the permission to read the user ID and their roles and permissions to implement access control features within the app.

  • Installation permissions: These permissions impact who can access the app. You can use the App access dropdown to make the app private or shared. If you select Private, then you can click + Add member below to add a member, or + Add project to add a project. The selected members/projects will be able to install the app.

  • Regenerate Client ID and Client secret: The Client ID and Client secret are the credentials that allow apps to perform actions on behalf of the user. If you lose or forget them, you can regenerate them after creating the app.

    • Client ID: Unique identifier of your app that is used for authentication and authorization. Your Client ID will only display after the app has been saved for the first time.
    • Client Secret: Used with the Client ID to resolve and grant access to your app. Your Client Secret will only display after the app has been saved for the first time.

Regenerate Client ID and Client SecretRegenerate Client ID and Client Secret

  • Transfer app ownership: An app can only be owned by one person at a time. App owners can hand over ownership to someone else if they won't be able to manage the app anymore. To transfer ownership, click Transfer ownership, and provide the email address of the new owner. The new owner receives an email with a confirmation link. As soon as they confirm, the ownership is transferred.

Transfer app ownershipTransfer app ownership

#Elements

App registration - ElementsApp registration - Elements

The Elements section will require different data depending on the element type you select. To start adding elements, click on + Add element:

  • Name: This is where you write the name of your element.
  • API ID: This is where you write your element's API ID.
  • Type: when you create an app, you can have field elements, sidebar elements, or pages.
    • field: Field elements are custom fields that you can add to a model's fields schema.
    • formSidebar: Sidebar elements are custom widgets that you can add to a model's sidebar schema.
    • page: Page adds a section for the app under App views in the Content editor.
  • Features: This dropdown only displays when field is selected as type, and allows you to select features for said field. One or more features can be selected using the dropdown:
    • FieldRenderer: If the feature contains this, it can be rendered for fields.
    • ListRenderer: If the feature contains this, it can be rendered for LIST fields. Click here to learn more about how it works.
    • TableRenderer: If the feature contains this, it can be rendered for Table Cell. Click here to learn more about how it works.
  • Field type: This dropdown only displays when field is selected as type . It allows you to select how the data will be stored, by selecting one of the standard field types from the dropdown menu.
  • URL: Indicates where this element is located in the project, its dedicated URL.
  • Description: It's the description that will appear under your field name in the Add Field / Sidebar Widgets section of the Schema.
  • Config: You can have custom settings for elements. This field is completed using a JSON object, which is used to declare extra fields the user wants to render in the field or sidebar form.
    • Click here for detailed information on field configuration.
    • Click here for detailed information on sidebar configuration.

#Sharing

App sharing enables other users to install your app.

App registration - SharingApp registration - Sharing

After creating an app and saving it for the first time, this section will show the App Sharing read-only field, which contains the URL that you can copy to then share your app.

#Registration

You can save your app by clicking on the Register app button, as long as you provide information in the required fields. We recommend you to click Register app only at the end of the process as some information - such as permissions - can't be edited after the initial save.

After you register your app for the first time, the client ID and client secret will be available on the Permissions tab of the app.

  • Client ID: Unique identifier of your app that is used for authentication and authorization. Your Client ID will only display after the app has been saved for the first time.
  • Client Secret: Used with the Client ID to resolve and grant access to your app. Your Client Secret will only display after the app has been saved for the first time.

The Client ID and Client secret are the credentials that allow apps to perform actions on behalf of the user.

If you lose or forget them, you will have the option to regenerate them after app creation.

Regenerate Client ID and Client SecretRegenerate Client ID and Client Secret

#Installation

After you've successfully created an app, you will need to install it in order to be able to use it. This guide contains step-by-step information on how to do this.

#Resources

  • App Framework: Overview to our App Framework, which extends Hygraph capabilities, offering the possibility of creating your own custom apps and sharing them with other users.
  • Use app tokens: How to exchange a setup code for an app token and use it to authenticate Hygraph API requests.
  • Install an app: Step by step guide on how to install an app in your Hygraph project.
  • Delete an app: Documentation for developers on how to delete an app you have created.
  • First steps: This is our App Framework tutorial, a comprehensive step-by-step guide on how to develop an app with custom field and sidebar elements.
  • Next.js starter: Document that guides you through the process of developing an app with a custom field using our Next.js starter.
  • API Reference: Our App Framework API Reference.