DEdefaulr
WebhookSubscriptions

List all webhook subscriptions

Changed on

List all webhook subscriptions for the workspace. Only workspace administrators can access this endpoint.

post/webhookSubscriptions.list

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/webhookSubscriptions.list
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

offsetnumber
limitnumber
sortstring
direction'ASC' | 'DESC'
querystring

Search query to filter webhook subscriptions by name.

Example request

{
  "limit": 25,
  "sort": "updatedAt",
  "direction": "DESC"
}

Response

OK

Example response

{
  "data": [
    {
      "name": "Production webhook",
      "url": "https://example.com/webhooks/outline",
      "secret": "ol_whs_1234567890abcdef",
      "events": [
        "documents.create",
        "documents.update"
      ],
      "createdBy": {
        "name": "Jane Doe"
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes