Skip to main content

 Services

Web services from /about to /webhooks

webhook

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

com.pageseeder.webhook.UpdateWebhook

Description

Updates an existing webhook.

The {webhook} URL parameter refers to the webhook ID.

Use the internal client id, not the client ID in the URL. For example: /clients/123/webhooks.json

Parameters

NameDescriptionRequiredTypeDefault
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

A successful response returns the <webhook> element wrapped in a <webhook-modification> element.

<webhook-modification>
  <webhook> ... </webhook>
</webhook-modification>

Sample XML

<webhook-modification>
  <webhook id="789" 
           created="2019-05-07T12:04:59+10:00"
           modified="2019-05-07T12:04:59+10:00" 
           url="https://ps.example.org/"
           server="false"
           object="minimal"
           format="xml"
           insecuressl="true"
           status="pending"
           name="Test"
           events="comment.*,group.*">
    <client id="123" 
            identifier="4739db31320c67c5" 
            requires-consent="false"
            confidential="false"
            name="sample"
            grant-type="password"
            created="2018-03-19T14:18:16+11:00"
            modified="2019-02-01T18:18:16+11:00"
            last-token="2022-07-06T17:00:00+10:00"
            description="Sample app"
            client-uri="https://app.example.org/"
            access-token-max-age="21600"
            refresh-token-max-age="2592000">
      <member id="456" status="activated"
              firstname="Joan" surname="Snow" username="jsnow">
        <fullname>Joan Snow</fullname>
      </member>
    </client>
  </webhook>
</webhook-modification>

Sample JSON

{
  "webhook": {
    "id": 789,
    "created": "2019-05-07T12:04:59+10:00",
    "modified": "2019-05-07T12:04:59+10:00",
    "url": "https://ps.example.org/",
    "server": false,
    "object": "minimal",
    "format": "xml",
    "insecuressl": true,
    "status": "pending",
    "name": "Test",
    "events": "comment.*,group.*",
    "client": {
      "id": 123,
      "identifier": "4739db31320c67c5",
      "requiresConsent": false,
      "confidential": false,
      "name": "Sample",
      "grantType": "password",
      "created": "2018-03-19T14:18:16+11:00",
      "modified": "2019-02-01T18:18:16+11:00",
      "lastToken": "2022-07-06T17:00:00+10:00",
      "description": "Sample app",
      "clientUri": "https://app.example.org/",
      "accessTokenMaxAge": 21600,
      "refreshTokenMaxAge": 2592000,
      "member": {
        "id": 456,
        "firstname": "Joan",
        "surname": "Snow",
        "username": "jsnow",
        "status": "activated",
        "fullname": "Joan Snow"
      }
    }
  }
}

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