Documentation Center

WebHooks Notifications (callbacks)

After a WebHook URI was registered for a certain event you will get callbacks when that event occurs. The callback is a POST request.

Request headers

ParameterExplanation
ms-signatureAn SHA 256 signature on the request body. The signature uses the secret key from the WebHook registration. Example: "

sha256=275F1BFF2327BBAF7F61A1BB1920BAC0A5295C2F4C78350324247031D37A8031"

X-Correlation-IDA correlation GUID - this is the actual id of a webhook item (from GroupShare)

Request body

Body typeExplanation
JSON (application/json)

The event details as a JSON string.

Example request body of an assignment event callback:

{                                                             
  "Id": "9745600de970448b97f1cff97dbf1860",                   
  "Attempt": 1,                                               
  "Properties": {},                                           
  "Notifications": [                                          
    {                                                         
      "Action": "Sdl.GroupShare.Events.V2.AssignmentEvent",   
      "From": [                                               
        {                                                     
          "userEmail": "projman@testsdl.com"                      
        }                                                     
      ],                                                      
      "To": [                                                 
        {                                                     
          "userEmail": "translator@testsdl.com"                   
        }                                                     
      ],                                                      
      "LanguageFileId": "1c210645-8b48-4557-b6e3-d50d1ca18ab4",
      "ProjectId": "6ed3763d-0a93-4484-89e3-c9b4b824701d",    
      "RaisedBy": "test",                                     
      "Server": "groupshare.local"                            
    }                                                         
  ]                                                           
}