Skip to main content

 Services

Web services from /about to /webhooks

webhooks

/clients/{client}/webhooks [GET]

com.pageseeder.webhook.ListWebhooksForClient

Description

Returns the list of webhooks for a specific OAuth client.

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

Parameters

No parameters required.

Permission

This service requires administrator.

Response

A successful response return a list of <webhook> elements. The client is returned within each webhook as a <client> element.

Sample XML

<webhooks>
  <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>
</webhooks>

Sample JSON

{
  "webhooks":[
    {
      "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

HTTP codeError condition
404If the client does not exist.
Created on , last edited on