Webhooks page
Key point: Use webhooks to notify other apps of PageSeeder events.

Use this page to manage the webhooks in PageSeeder.

A webhook is a method to trigger an HTTP callback upon a specific PageSeeder event. This is used to notify a third-party app that the event took place and allow it to take action accordingly.

For example, if a third-party app caches PageSeeder comments, it could define a webhook to update its cache in case a comment is created by email on PageSeeder.

Reviewing existing webhooks

All the existing webhooks are listed in a table indicating their current status. Here are the possible statuses and their meaning:

Client application cache means any cache an app outside PageSeeder uses to cache PageSeeder data. This is different from the PageSeeder Webhook caches which store jobs and events persistently so pending events can still be processed after PageSeeder is restarted.

Pinging a webhook

You ping a webhook to verify that the target URL still accepts requests from PageSeeder.

Registering a webhook

A webhook must have a URL and a registered OAuth 2.0 client. The following options can be defined:

  • Object type: minimal – means that only private and public IDs are returned for the object (no other content). This includes: no attributes for groupproperties, id only for comment, task, workflow, membership, server and the following:

    • uri: id, docid, path

    • member: id, username, email

    • groupfolder: id, path

    • group: id, name

    • project: id, name

    • webhook: id, name

  • Support insecure SSL – means that the SSL certificate is not checked when sending requests. This can be useful for development servers but shouldn’t be used for production.
  • Event filters – means the events that are sent to this webhook. Multiple event types can be specified by selecting different event types repeatedly.
  • Include server events – means include the following events which are not specific to a project or group: member.created, member.modified, member.deleted, project.created, server.started

Don’t register all possible events with your webhook. This creates a lot of unnecessary network chatter and waste resources. Only register the events that you need to monitor.

Deleting a webhook

You can delete a web hook at any time to stop PageSeeder from sending any more callback requests to the app.

How to find this page

Administration menu >  System administration > OAuth > Webhooks