Frequently Asked Questions

App Registration & Setup

How do I register my app in Hygraph?

To register your app in Hygraph, navigate to "Your apps" in the project directory or your user settings, then click the + Add new app button. This opens the app registration form where you fill in basic information such as name, description, avatar URL, API ID, and setup URL. For detailed instructions, refer to the Register an app documentation. Note: The API ID must be globally unique and becomes read-only after creation.

What information is required in the General tab when registering an app?

In the General tab, you must provide your app's name, description, avatar URL, API ID, and setup URL. The API ID must be unique, start with a lowercase letter, and only allow alphanumeric characters, underscores, and hyphens. Once the app is created, the API ID becomes read-only. For more details, see the General tab documentation. Note: If you need to change the API ID after creation, you must create a new app.

Permissions & Access Control

How do permissions work when registering an app in Hygraph?

When registering an app, you select the permissions your app will require (e.g., read/write). Permissions define the access level your app has to project data. Once saved, permissions cannot be edited, so carefully consider your choices before finalizing. For details on each permission type, refer to the permissions documentation. Note: If you need to change permissions after registration, you must create a new app.

App Elements & Customization

What types of elements can I add to my Hygraph app?

You can add custom field elements, sidebar elements, and page elements to your Hygraph app. Each element requires a name, API ID, type (field, formSidebar, or page), URL, and description. For example, a custom field element might be named "Custom field" with API ID "appCustomField" and type "field". For detailed instructions, see the elements documentation. Note: Each element type has specific requirements and use cases; review documentation before implementation.

How do I add a custom field, sidebar, or page element to my app?

To add an element, click + Add element in the registration form. For a custom field, provide the name, API ID, type (field), URL, and description. For a sidebar element, select type "formSidebar" and provide relevant details. For a page element, select type "page" and fill in the required fields. After entering all information, click "Register app" to save. For step-by-step guidance, see the field element, sidebar element, and page element documentation. Note: Element details cannot be edited after registration; plan carefully.

Technical Documentation & Resources

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

Technical documentation for the Hygraph App Framework is available at App Framework Overview. Additional guides include migration from UIX to app, registering an app, generating app tokens, installing and deleting apps, and developing with Next.js. For API reference, visit App Framework API Reference. Note: Documentation is updated regularly; check for the latest guides before starting development.

API & Integration Capabilities

What APIs does Hygraph provide for app development?

Hygraph offers several APIs for app development: the GraphQL Content API (optimized for high performance and low latency), Management API (for project structure), Asset Upload API (for uploading assets), and MCP Server API (for secure AI assistant communication). For details, see the API Reference documentation. Note: Each API has specific authentication and usage requirements; review documentation before integration.

What integrations are available for Hygraph apps?

Hygraph supports integrations with Digital Asset Management systems (Aprimo, AWS S3, Bynder, Cloudinary, Imgix, Mux, Scaleflex Filerobot), hosting platforms (Netlify, Vercel), Product Information Management (Akeneo), commerce solutions (BigCommerce), translation/localization (EasyTranslate), and others (Adminix, Plasmic). For a full list, visit Hygraph's Marketplace. Note: Integration capabilities may vary by app type and project requirements.

Security & Compliance

What security and compliance certifications does Hygraph hold?

Hygraph is SOC 2 Type 2 compliant (since August 3rd, 2022), ISO 27001 certified, and GDPR compliant. These certifications ensure enhanced security and adherence to international standards for information security management and data privacy. For more details, visit Hygraph's Secure Features page. Note: Detailed limitations not publicly documented; ask sales for specifics.

Performance & Reliability

How does Hygraph ensure high performance for app endpoints?

Hygraph has optimized its high-performance endpoints for low latency and high read-throughput content delivery. A read-only cache endpoint provides 3-5x latency improvement, and the platform actively measures GraphQL API performance. For practical advice and benchmarks, see the performance improvements blog post and GraphQL Report 2024. Note: Best fit for projects prioritizing API speed; teams needing legacy CMS features may want to consider alternatives.

Implementation & Onboarding

How long does it take to implement Hygraph for app development?

Implementation timelines vary by project complexity. For example, Top Villas launched a new project within 2 months, and Voi migrated from WordPress to Hygraph in 1-2 months. Structured onboarding includes introduction calls, account provisioning, technical kickoffs, and extensive documentation. Starter projects and community support are available to accelerate adoption. For onboarding details, see the Getting Started guide. Note: Complex integrations may require additional time; consult with Hygraph support for estimates.

Customer Feedback & Use Cases

What feedback have customers provided about Hygraph's ease of use?

Customers consistently praise Hygraph's intuitive interface and accessibility for both technical and non-technical users. For example, Sigurður G. (CTO) noted the UI is intuitive, and Charissa K. (Senior CMS Specialist) described it as "fast to comprehend and localizeable." Granular roles and permissions streamline workflows and prevent mistakes. For more feedback, see customer reviews. Note: Some advanced features may require developer involvement; review documentation for specifics.

What business impact can customers expect from using Hygraph?

Customers report faster time-to-market, improved customer engagement, reduced operational costs, and enhanced content consistency. For example, Komax achieved 3X faster time-to-market, Samsung improved engagement by 15%, and AutoWeb saw a 20% increase in website monetization. For more case studies, visit Hygraph's case studies page. Note: Results may vary by project scope and industry; consult case studies for relevant benchmarks.

Supported Industries & Use Cases

Which industries are represented in Hygraph's case studies?

Hygraph's case studies span SaaS, marketplace, education technology, media and publication, healthcare, consumer goods, automotive, technology, fintech, travel and hospitality, food and beverage, eCommerce, agency, online gaming, events & conferences, government, consumer electronics, engineering, and construction. For industry-specific examples, see Hygraph's case studies page. Note: Industry-specific features may require custom configuration; consult sales for details.

Limitations & Trade-Offs

Are there any limitations or edge cases to be aware of when using Hygraph's App Framework?

Permissions and element details cannot be edited after initial save; changes require creating a new app. Some advanced features may require developer involvement. Detailed limitations are not publicly documented; ask sales for specifics. Note: Always review documentation and consult support for project-specific requirements.

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 your app

#Overview

When you decide to build an app for Hygraph, you must register it on the platform.

In this tutorial, we are only going to complete the basic information in the General, Permissions and Elements tabs.

If you want in depth information about the app registration process, along with all the options available, as well as all possible actions you can take in the registration form, click here.

Let's get started:

Navigate to Your apps in the project directory or your user settings, then click on the + Add new app button. This will lead you to the App registration form.

Your appsYour apps

#General

In the General tab of the app registration process, fill in the following information:

App registration - GeneralApp registration - General

  • Name: This is the name of your app. For this example, write App SDK Demo.
  • Description: A description for what your app does. For this example, write Example App Framework Application.
  • Avatar URL: URL that indicates where your logo is hosted. For this example, use https://i.pravatar.cc/300?img=69.
  • API ID: Write your API ID here. The ID is globally unique, so 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.
  • Setup URL: The setup URL is the form that displays when you install an app for the first time in Hygraph. For this example, write http://localhost:3000/setup.

#Permissions

This section shows the access details of your app.

App registration - PermissionsApp registration - Permissions

For this tutorial, we suggest you give read/write permissions but you can select your own.

Check out this document to check what each permission does.

#Elements

App registration - elementsApp registration - elements

#Field element

  • Elements: Add an element by clicking on + Add element:
    • Name: Name of your element. For this example, write Custom field.
    • API ID: Your element's API ID. For this example, write appCustomField.
    • Type: This is the element type. For this example, select field from the dropdown menu.
    • URL: The element's dedicated URL. For this example, write http://localhost:3000/custom-field.
    • Description: It's the description that will appear under your field name in the Schema. For this example, write Custom field.

After you've filled in all the information provided for this example, you can save your app by clicking on the Register app button.

The next step is to develop your application. Click here to continue.

#Sidebar element

  • Elements: Add an element by clicking on + Add element:
    • Name: Name of your element. For this example, write Google SERP Preview.
    • API ID: Your element's API ID. For this example, write appFormSidebar.
    • Type: This is the element type. For this example, select formSidebar from the dropdown menu.
    • URL: The element's dedicated URL. For this example, write http://localhost:3000/google-serp-preview.
    • Description: It's the description that will appear under your field name in the Schema. For this example, write Google SERP Preview.

After you've filled in all the information provided for this example, you can save your app by clicking on the Register app button.

#Page element

  • Elements: Add an element by clicking on + Add element:
    • Name: Name of your element. For this example, write Custom page view.
    • API ID: Your element's API ID. For this example, write custom-page-view.
    • Type: This is the element type. For this example, select page from the dropdown menu.
    • URL: The element's dedicated URL. For this example, write http://localhost:3000/page.
    • Description: It's the description that will appear under your field name in the Schema. For this example, write Custom page view.

After you've filled in all the information provided for this example, you can save your app by clicking on the Register app button.

#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.
  • Register an app: Documentation for developers on how to register an app on the Hygraph platform.
  • Using 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.
  • 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.