{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/namirialsignenterprise/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["img"]},"type":"markdown"},"seo":{"title":"Webhooks","description":"Integration and usage documentation."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"webhooks","__idx":0},"children":["Webhooks"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note that this section is only visible if the feature flag ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OrganizationWebhook"]}," is enabled for your organization."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A Webhook lets NSE notify an external system automatically when an event occurs in your organization. When the event is triggered, NSE sends an HTTP request to the URL you configure, so your systems can react in real time without polling the API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Currently, the following event is supported:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event"},"children":["Event"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Envelope completed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Triggered when an envelope has been completed."]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["one"]}," organization webhook can be configured. Once a webhook exists, the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New Webhook"]}," button is disabled. A webhook cannot be edited: to change its configuration, delete it and create a new one."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It is also possible to configure webhhooks via api (on organization level as well as on envelope level): ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/namirialsignenterprise/namirialsignenterprise-knowledge-center/03-developer-documentation/01-api-reference/webhook-reference"},"children":["Webhook Reference"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"navigation","__idx":2},"children":["Navigation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Organization Settings → Webhooks"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Access to Webhooks under Organization Settings is restricted to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["organization administrators"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"webhooks-list","__idx":3},"children":["Webhooks List"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The list shows the configured webhook with the following columns:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Column"},"children":["Column"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Event"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The event that triggers the webhook."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The endpoint that receives the notification."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Actions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Details"]}," to view the webhook configuration, or the trash icon to delete it."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When no webhook is configured, the list shows ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["No webhooks here yet"]},"."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/webhooks-1.9f8a4e795e6ab730dd34f2c97c8aeb58cd6920562e9fa4f08ee6e07ea8a36b42.4d07ae9a.png","alt":"No image","framed":false,"withLightbox":false},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"creating-a-webhook","__idx":4},"children":["Creating a Webhook"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New Webhook"]}," and fill in the form."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Event"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The event that triggers the webhook. Only ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Envelope completed"]}," is available."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The URL of your endpoint that receives the notification."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Headers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom headers sent with every request. Each header consists of a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Name"]}," and a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Value"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client certificate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client certificate (text) used to authenticate NSE to your endpoint."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Private key (text) matching the client certificate."]}]}]}]}]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/webhooks-2.0e16d10a640325ab55a6f6635a2c803d725a9e9115c7cddf00c6a6284240b42a.4d07ae9a.png","alt":"No image","framed":false,"withLightbox":false},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"headers","__idx":5},"children":["Headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use headers to pass static information to your endpoint, for example an authorization token."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add header"]}," (＋)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter the header ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Name"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Value"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Repeat for every additional header. Use the remove action to delete a header."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"client-certificate-and-key","__idx":6},"children":["Client Certificate and Key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your endpoint requires mutual TLS, paste the client certificate in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client certificate"]}," and the corresponding private key in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client key"]},". Both fields are optional."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]}," to create the webhook, or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Cancel"]}," to discard your changes. The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]}," button is enabled once the required fields are filled in."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"viewing-and-deleting-a-webhook","__idx":7},"children":["Viewing and Deleting a Webhook"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Webhooks cannot be edited after creation."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Details"]}," — opens the webhook to view its configuration (event, URL, headers)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete"]}," (trash icon) — removes the webhook. After deletion, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New Webhook"]}," becomes available again, so you can create a new webhook with the updated configuration."]}]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/webhooks-3.0f9087f1fac67702cf37af24b6adc16ff948a84802b186890f6d1f5e6e46e539.4d07ae9a.png","alt":"No image","framed":false,"withLightbox":false},"children":[]}]},"headings":[{"value":"Webhooks","id":"webhooks","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Navigation","id":"navigation","depth":2},{"value":"Webhooks List","id":"webhooks-list","depth":2},{"value":"Creating a Webhook","id":"creating-a-webhook","depth":2},{"value":"Headers","id":"headers","depth":3},{"value":"Client Certificate and Key","id":"client-certificate-and-key","depth":3},{"value":"Viewing and Deleting a Webhook","id":"viewing-and-deleting-a-webhook","depth":2}],"frontmatter":{"seo":{"title":"Webhooks"}},"lastModified":"2026-11-18T09:54:17.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/namirialsignenterprise/namirialsignenterprise-knowledge-center/02-products-and-modules/01-nse/02-nse-settings/organization-webhooks","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}