Topview Logo
  • Create viral videos with
    GPT-4o + Ads library
    Use GPT-4o to edit video empowered by Youtube & Tiktok & Facebook ads library. Turns your links or media assets into viral videos in one click.
    Try it free
    gpt video - Web Hooks and Management API

    blog thumbnail - Web Hooks and Management API

    In this article, we will explore two important concepts in webhooks and the management API. Webhooks are a way to extend beyond its out-of-the-box capabilities and interact with other microservices in a headless CMS architecture. The management API allows us to write data to the CMS, unlike the delivery API which is used to pull data from the CMS.

    To begin, we need to create an API endpoint file where we will handle the webhooks. We import the necessary modules and create a basic function that will provide us with an output message. We then test the API endpoint using Postman.

    Next, we set up the webhook in by hosting our web application in a hosting environment like Vercel. We create a new webhook in the CMS and define its triggers, such as a workflow step change. We then link the webhook to our workflow and trigger it by moving a content item to the specified workflow step.

    We can view the status of our webhooks in the CMS and debug any issues that may arise. The payload sent by the webhook to our API endpoint includes information such as the item ID, language, workflow steps, project ID, and more.

    In the next step, we utilize the payload data from the webhook to update the content item in the CMS. We use the management API SDK to initialize our client and make the necessary updates to the specified content item.

    Finally, we summarize the importance of webhooks and the management API in extending's functionality and ensuring seamless integration with other microservices. We also mention the use of custom elements as another way to extend


    webhooks, management API,, CMS, microservices, API endpoint, payload, workflow step, content item, SDK, custom elements


    Q: What are webhooks and how do they extend
    A: Webhooks are a way to extend beyond its out-of-the-box capabilities. They allow to interact with other microservices in a headless CMS architecture, enabling tasks such as updating search index services or sending content for translation to third-party services.

    Q: What is the management API in
    A: The management API in allows users to write data to the CMS. It is used to make updates to content items, workflow steps, and other aspects of the CMS.

    Q: How do I set up a webhook in
    A: To set up a webhook in, you need to create an API endpoint file, host it in a hosting environment, and define the triggers for the webhook. This includes specifying when the webhook should be triggered, such as a workflow step change.

    Q: How can I debug issues with webhooks in
    A: provides a webhook debugging feature that allows you to view the status of your webhooks and investigate any issues. You can check the response details, including any errors or failed requests, to troubleshoot and fix problems.

    Q: Can I use webhooks to update content items in
    A: Yes, webhooks can be used to update content items in By utilizing the payload data sent by the webhook, you can make updates to specific fields or elements within a content item using the management API.

    Q: Is there a way to extend further?
    A: Yes, apart from webhooks and the management API, you can also extend through the use of custom elements. Custom elements allow you to create custom fields and components to enhance the content editing experience and tailor it to your specific needs.

    One more thing

    In addition to the incredible tools mentioned above, for those looking to elevate their video creation process even further, stands out as a revolutionary online AI video editor. provides two powerful tools to help you make ads video in one click.

    Materials to Video: you can upload your raw footage or pictures, will edit video based on media you uploaded for you.

    Link to Video: you can paste an E-Commerce product link, will generate a video for you.

    You may also like