Get Started
API backend
API system
More information

PUT api/2.0/settings/webhook This function requires authentication

Description

Updates the tenant webhook with the parameters specified in the request.

Parameters
Name Description Type Example
Id
sent in body
ID System.Int32
Uri
sent in body
URI System.String
SecretKey
sent in body
Secret key System.String
Enabled
sent in body
Enabled or not System.Nullable{System.Boolean}
Example
PUT api/2.0/settings/webhook
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "Id": 1234,
  "Uri": "some text",
  "SecretKey": "some text"
}
Returns

Updated tenant webhook with its config parameters

Example Response

application/json

{
  "status": 0,
  "response": {
    "Id": 1234,
    "Uri": "some text",
    "SecretKey": "some text",
    "Enabled": true
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>1234</Id>
    <Uri>some text</Uri>
    <SecretKey>some text</SecretKey>
    <Enabled>True</Enabled>
  </response>
</result>