Skip to main content
NiCE KnowledgeKnowledge
NiCE Knowledge Success Center

Webhooks management via Dashboard

  1. Last updated
  2. Save as PDF
Site admins can create, view, edit, pause, and delete webhook subscriptions directly from the Dashboard, without calling the REST API. Use the Dashboard for quick, one-off, admin-driven changes; use the REST API when you need to script, template, or bulk-manage subscriptions, for example as part of a deployment process.

This page covers the Dashboard workflow. For details on webhook payloads, signature verification, delivery batching and retries, and troubleshooting delivery problems, see the Webhook integration guide. If you are scripting webhook setup instead of using the Dashboard, see the Webhook setup script.

Prerequisites

You must have an admin user role, and webhooks enabled for your site. Reach out to Support if you do not have this functionality enabled yet.

Access the Webhooks page

Navigate to Dashboard > Integrations > Webhooks.

If no subscriptions exist yet, the page shows: “No webhooks configured yet. Create one to start receiving event notifications.”

Subscriptions created earlier through the REST API or the setup script also appear on this page. The Dashboard reads and writes the same underlying subscriptions as the API, so a webhook can be created in one place and edited in the other.

Create a webhook subscription

  1. Navigate to Dashboard > Integrations > Webhooks.
  2. Click the Create webhook button.
  3. Enter the Webhook URL. This is the endpoint that receives the signed event payloads. This field is required and must begin with https:// . Non-HTTPS URLs are rejected with an inline error and the form stays open so you can correct it.
  4. (optional) Enter an Authorization header value (for example, a bearer token) if your endpoint requires one.
  5. Check the Page events, Attachment events, and User events you want this webhook to fire on. Use each group's Select all control to subscribe to every event in that group.
  6. Save.

On success, you will see a confirmation message, and a new row for the subscription with a status of Active and a count of the events it is subscribed to.

A subscription with no events selected will not receive any notifications.

Edit a subscription

  1. Navigate to Dashboard > Integrations > Webhooks.
  2. Find the subscription in the list and click the Edit button.
  3. Update the fields as needed.
  4. Save.
The Authorization header field is always shown as blank when you edit a webhook, even if a value is already stored for that subscription. The placeholder reads “Enter a new value to replace existing.” This is intentional so the stored token is not displayed in the UI.

Leave the field blank and save to preserve the existing header. Type a new value to replace it. There is no way to view a previously stored header from the Dashboard or the API.

Pause or activate a subscription

Use Pause to stop a subscription from receiving deliveries without deleting its configuration, and Activate to resume deliveries.

  1. Navigate to Dashboard > Integrations > Webhooks.
  2. Find the subscription in the list and click the Pause button. The Pause button will become an Activate button.
  3. To unpause, click the Activate button.
To verify a webhook is working as expected, test it against a temporary endpoint (for example, the webhook.site approach in Webhook setup script) or your own endpoint's logs.

Delete a subscription

  1. Navigate to Dashboard > Integrations > Webhooks.
  2. Find the subscription in the list and click the Delete button.
  3. Click the Delete button in the confirmation dialog.

Deletion is immediate and cannot be undone. If you need the same configuration again later, you can recreate it via the Dashboard or the API.

Event types

The Dashboard groups events the same way as the underlying API. Select individual events, or use a group's Select all checkbox.

Page events

  • Page_Create
  • Page_Copy
  • Page_Move
  • Page_Restore
  • Page_Delete
  • PageTag_Update
  • PageProperty_Create
  • PageProperty_Delete
  • PageProperty_Update
  • PageDisplayname_Update
  • PageRestriction_Update
  • PageGrant_Create
  • PageGrant_Delete
  • PageContent_Update
  • PageContentType_Update
  • PageContent_ContentReuseUpdate

Attachment events

  • Attachment_Restore
  • Attachment_Copy
  • Attachment_Move
  • Attachment_Delete
  • Attachment_Update
  • Attachment_Create
  • AttachmentProperty_Update
  • AttachmentProperty_Create
  • AttachmentProperty_Delete

User events

  • User_Update
  • User_Create

How this relates to the REST API

The Dashboard is a UI layer over the same webhooks feature documented in Webhook integration guide and Webhook setup script. It does not introduce a new backend or event schema.

  • Gating: The Dashboard is hidden unless site/webhooks/enabled is true, the same key the API has always used. One additional check applies only to the Dashboard page: the user must be a site admin.
  • Same subscriptions: The list on this page shows every subscription for the site, regardless of how the webhook was created.
  • Same delivery behavior: The payload format, request headers, signature verification (X-Nexus-Signature-256), batching, timeouts, and retry / backoff behavior are unchanged. Refer to Webhook integration guide for those details.

Related articles

  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Article type
    Reference
  2. Tags
    This page has no tags.