Skip to main content

 Web service API

How to use PageSeeder's Web service API

webhook

/clients/{client}/webhooks/{webhook} [PATCH]

com.pageseeder.webhook.UpdateWebhook

Description

Updates an existing webhook.

Parameters

NameDescriptionRequiredTypeDefault value
eventsComma-separated list of events to filter (empty means all, .* suffix can be used)nostring
formatThe output format xmlorjsonnostring
groupsComma-separated list of groups to filter events (in addition to projects, empty projects & groups means all)nostring
insecuresslIf the SSL certificate for the URL is verifiednoboolean
nameThe webhook name, optional stringnostring
objectThe objects’ format in the output (minimal(public/private IDs only)|basic(no groups)nostring
projectsComma-separated list of projects to filter events (empty projects & groups means all)nostring
serverIf the server events are includednoboolean
statusThe webhook status pending, active, disabled, warning, error, unreachablenoenum
urlThe webhook URL stringnourl

Permission

This service requires administrator.

Response

<webhook-modification>
  <webhook webhookid=""
           created=""
           modified=""
           url=""
           server="[true|false]"
           [name=""]
           [activatesecret=""]
           [projects=""]
           [groups=""]
           [events=""]
           object="[minimal|basic]"
           format="[xml|json]"
           insecuressl="[true|false]"
           status="[pending|active|disabled|warning|error|unreachable]">
    <client ...>
      <member ...> ... </member>
    </client>
  </webhook>
</webhook-modification>

Error Handling

0x1701 If the client is invalid
0x1702 If the name is already in use
0x1703 If the URL is invalid
0x1704 if the object parameter is not valid
0x1705 if the format parameter is not valid
0x1706 If one of the projects is invalid
0x1707 If one of the groups is invalid
0x1708 If one of the events is invalid
0x1709 If the status is invalid
Created on , last edited on