Skip to main content

 Services

Web services from /about to /webhooks

webhook

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

com.pageseeder.webhook.GetWebhook

Description

Returns information about the webhook on a specific client.

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

No parameters required.

Permission

This service requires administrator.

Response

A successful response returns the <webhook> element.

Sample XML

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

Sample JSON

{
  "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 webhook does not exist
Created on , last edited on