DEdefaulr
Subscriptions

Create a subscription

Changed on

Subscribe the authenticated user to a document or collection so that they receive notifications when it changes. Provide exactly one of documentId or collectionId.

post/subscriptions.create

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/subscriptions.create
  • 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

event'documents' required

The type of event to subscribe to.

documentIdstring uuid

The document to subscribe to. Provide exactly one of documentId or collectionId.

collectionIdstring uuid

The collection to subscribe to. Provide exactly one of documentId or collectionId.

Response

OK

Example response

{
  "data": {
    "event": "documents"
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes