v1

latestOpenAPI 3.0.12026-08-0640103344.9 KB
Webhooks

Update notification setting

Authentication methods provided for secure communication of webhooks are given below. For each URL, value of authentication type must be passed.

Authentication TypeValueDescription
No AuthenticationnoneWebhooks are accessible without any authentication requirements. RequiredParameters: authenticationType
Basic AuthenticationbasicUsers must include a username and password with each webhook which is encoded and sent with request. RequiredParameters: authenticationType, userName, password
Bearer Token AuthenticationoauthIn this method, token generated by the server are included in request headers. RequiredParameters: authenticationType, clientId, clientSecret
patch/orgunit/{orgunitId}/groups/{groupId}/notification-url

Path parameters

orgunitIdstring required

orgunitId

groupIdstring required

groupId

Request body

callbackUrlEnabledboolean
statusUrlEnabledboolean
personalUrlEnabledboolean

Response

Success

appCodestring
messagestring
isErrorboolean