Webhooks

Last updated
Save as PDF

Webhooks provide real-time notifications for events that occur within a site. When specific events happen (for example, page creations, user updates, or file modifications), the system automatically notifies your external applications via HTTP POST requests.

Benefits

Webhooks connect NiCE KM to your workflow for a seamless integration, providing instant notification of NiCE KM platform events in your existing tools without manual polling or delays.

Reduce latency: Instantly receive automatic, real-time updates in external apps.
Automate business processes: Your systems can react in real-time to changes.
Save time and effort: Webhooks standardize event delivery without custom integration efforts.

Webhook documentation

Webhooks management via Dashboard: create, edit, pause, and delete subscriptions in the Dashboard.
Webhook integration guide: technical reference for developers. Covers the API, request format, headers, payloads, signature verification, delivery and failure behavior, and troubleshooting.
Webhook setup script: create subscriptions with a script instead of the Dashboard.

Supported events

The webhook system supports the following event types. Events identify what changed, such as a page ID or user ID, not the changed values.

Page events

Event type	Triggered when
`Page_Create`	New page created
`Page_Copy`	Page duplicated
`Page_Move`	Page relocated
`Page_Restore`	Page recovered from deletion
`Page_Delete`	Page removed
`PageContent_Update`	Page content modified
`PageTag_Update`	Page tags changed
`PageProperty_Create`	Page property added
`PageProperty_Update`	Page property modified
`PageProperty_Delete`	Page property removed
`PageDisplayname_Update`	Page display name changed
`PageRestriction_Update`	Page permission/restriction changed
`PageGrant_Create`	Page-level permission grant added
`PageGrant_Delete`	Page-level permission grant removed
`PageContentType_Update`	Page content type changed
`PageContent_ContentReuseUpdate`	Reused content block updated

Attachment events

Event type	Triggered when
`Attachment_Create`	New file uploaded
`Attachment_Copy`	File duplicated
`Attachment_Move`	File relocated
`Attachment_Restore`	File recovered from deletion
`Attachment_Delete`	File removed
`Attachment_Update`	File modified
`AttachmentProperty_Create`	File property added
`AttachmentProperty_Update`	File property modified
`AttachmentProperty_Delete`	File property removed

User events

Event type	Triggered when
`User_Create`	New user account created
`User_Update`	User account modified

Which user changes raise an event:

Change	Event
User created through the API, the Control Panel (including CSV bulk add), or a site user import	`User_Create` (one per user)
User created by single sign-on just-in-time (JIT) provisioning on first login	`User_Create`, possibly followed by `User_Update` when profile or seat details are synchronized
Profile edits: username, email, name, language, time zone, role, preferred name	`User_Update`
Deactivation or reactivation by an administrator	`User_Update`
License seat assigned or removed	`User_Update`
Group membership added or removed	No webhook event
Password set, changed, or reset	No webhook event
Login (including last-login updates)	No webhook event
User property created, updated, or deleted	No webhook event
Account locked by brute-force protection	No webhook event
Users provisioned or changed through SCIM	No webhook event

A single change can produce more than one User_Update. For example, one request that renames a user and assigns a seat can raise several events.
User_Create is raised when the user account is created. User properties are always set in separate API requests, so they may not exist yet when User_Create is raised. Setting a user property does not raise User_Update.
To keep group membership or user properties in sync, read them from the API on a schedule.