Subscriptions API Resource

WS for push subscriptions

DELETE /subscriptions/json

Remove subscription to given event.

Example of request:

{"list":[{"eventName":"DraftShared"},{"eventName":"DocumentChanged","parameters":{"documentId":"10"}}]}

Request Body
media type data type
application/json string
Response Body
media type data type description
application/json object Response with information, whether the operation has or has not been succeeded.

GET /subscriptions/json

Get list of subscriptions.

Response Body
media type data type description
application/json object JSON Response with list of events

Example of response:

{"list":[{"eventName":"DraftShared","parameters":{}},{"eventName":"DraftUnshared","parameters":{"draftId":"10"}}]}

POST /subscriptions/json

Add subscriptions to given events.

Example of request:

{"list":[{"eventName":"DraftShared"},{"eventName":"DocumentChanged","parameters":{"documentId":"10"}}]}

Request Body
media type data type
application/json string
Response Body
media type data type description
application/json object Response with information, whether the operation has or has not been succeeded.

GET /subscriptions/notifications/token

Remove subscription to given event.

Example of request:

{"list":[{"eventName":"DraftShared"},{"eventName":"DocumentChanged","parameters":{"documentId":"10"}}]}

Response Body
media type data type description
application/json object Response with information, whether the operation has or has not been succeeded.