> For the complete documentation index, see [llms.txt](https://docs.nalpeiron.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nalpeiron.com/zentitle2-docs/ui-administration/webhooks.md). # Webhooks Set up webhooks to receive real-time notifications from Zentitle2 instead of polling the API, and learn how to verify each call's signature for security. ### About Webhooks Our webhooks are a more efficient way of managing events than using the management API to query information that changes over time. Instead of constantly polling for updates, a webhook is set up once and is only triggered when a specific event occurs. The main advantage of webhooks is that they provide real-time data updates on the various parameters used in license management. Webhooks are callback mechanisms that web applications use to provide real-time notifications to other systems. Essentially, a webhook is a way for an application to send data to another application automatically when certain events occur. The basic idea behind webhooks is that one application sends an HTTP POST request to a URL specified by another application, indicating that a certain event has occurred. The receiving application then processes the data in the request and takes appropriate action based on the content. Webhooks are commonly used in a wide variety of applications, such as: * Integrating with third-party services to receive notifications when specific events occur * Triggering custom workflows or automation tasks in response to user actions * Updating data in real-time across multiple systems and applications * Automating data synchronization between different systems In essence, webhooks operate in contrast to APIs, which require the client application to continuously request updates from the server. With webhooks, the server proactively pushes data to the client, eliminating the need for the client to check for updates and reducing the server's workload constantly. ### Security Each webhook call is sent with the `N-Signature` header in the HTTP Post request. This header contains a signature of the webhooks payload message created with your account's RSA key. It's a good practice to create a signature from the payload received and compare it with the header value. If it matches, it means the webhook was sent by the Zentitle2 service and not by a malicious actor. The RSA key can be obtained from the "Administration > API Credentials > Licensing API" page. An example of the signature verification is implemented in our example code: ### Managing webhooks

#### Adding a webhook Webhooks are located under the "**Administration**" > "**Webhooks**" on the top menu.

![](https://2412542193-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1tBhTGn5igyI6ECLHjpC%2Fuploads%2FBggKfcwtHYyokAoW6CA4%2Fcounter_2_FILL0_wght400_GRAD0_opsz24.svg?alt=media\&token=b4a1c291-524f-4064-838e-5dfaac404fea) Enter the URI of the webhook handler.

![](https://2412542193-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1tBhTGn5igyI6ECLHjpC%2Fuploads%2FgP2ydddGH7JrOOoUkK6o%2Fcounter_3_FILL0_wght400_GRAD0_opsz24.svg?alt=media\&token=25e6aed0-9d7d-4425-b8d7-82ae916130d2) Select the events that you wish the handler to manage.

![](https://2412542193-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1tBhTGn5igyI6ECLHjpC%2Fuploads%2FPDkUUXICZp0VjoNW7xDd%2Fcounter_4_FILL0_wght400_GRAD0_opsz24.svg?alt=media\&token=76f36e3b-7c9c-4fcf-b9bc-fe96049d5b4d) Click on 'Save Events'.

![](https://2412542193-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1tBhTGn5igyI6ECLHjpC%2Fuploads%2FeDNjcr6hYAUKl9tnMeXo%2Fcounter_5_FILL0_wght400_GRAD0_opsz24.svg?alt=media\&token=c1110a9d-a776-4560-a37a-e9cf95e523cd) Then click on 'Save' to add the webhook: *** #### Editing a webhook

![](https://2412542193-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1tBhTGn5igyI6ECLHjpC%2Fuploads%2FIvC85MvJkVs2NsLCzG2A%2Fcounter_1_FILL0_wght400_GRAD0_opsz24.svg?alt=media\&token=e9e24ee0-b25b-4028-a774-f5b21e399e85) To test your webhook handler, click on the 'Test' button to the right of the listed events. ![](https://2412542193-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1tBhTGn5igyI6ECLHjpC%2Fuploads%2FBggKfcwtHYyokAoW6CA4%2Fcounter_2_FILL0_wght400_GRAD0_opsz24.svg?alt=media\&token=b4a1c291-524f-4064-838e-5dfaac404fea) Confirm you wish to trigger a call to the specified webhook handler. This action generates a new WebhookEvent and triggers a call to the listener URI. The payload of this call is empty; the resource id contains the ID of the listener: ![](https://2412542193-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1tBhTGn5igyI6ECLHjpC%2Fuploads%2FWFXvlttw9vdh2ZIVUj33%2Ftest%20webhook2.png?alt=media\&token=bc585b16-d948-40d8-bf71-18ec67929ad6) {% hint style="warning" %} This event is not retried if the request fails. Hit 'Test' again to generate another event. {% endhint %} ### Using webhooks Go to our API docs for more details on using the webhooks you have set up: ### Examples and payloads You can find examples as well as payloads on our API docs page in the "Webhook Events" section:\ *** Now [go to the SDK and API documentation](/zentitle2-docs/developers/licensing-and-management-apis.md) to learn about implementation. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.nalpeiron.com/zentitle2-docs/ui-administration/webhooks.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.