Other information related to Trados GroupShare WebHooks

Receiver and Sending flows

WebHook Receiver Registration Flow

WebHook receiver registration flow

Registration Request Structure

{
  "WebHookUri":"http://<hosturl>/api/webhooks/incoming/custom",
  "Secret":"12345678901234567890123456789033",
  "Description":"Sample WebHook Reciever.",
  "Filters":[ "Sdl.GroupShare.Events.V2.ProjectCreatedEvent",
              "Sdl.GroupShare.Events.V2.PhaseChangeEvent",
              "Sdl.GroupShare.Events.V2.AssignmentEvent",
              "Sdl.GroupShare.Events.V2.CheckInEvent",
              "Sdl.GroupShare.Events.V2.CheckoutEvent"
            ]
}

Sending WebHook Messages Flow

Sending WebHook messages flow

Event Message Design

Project Created Event

Headers
KeyValue
X-Correlation-IDCorrelation ID
Message Body
Property nameValue
ProjectIdProject ID
ProjectNameProject name
RaisedByUsername of the user who triggered the event
ServerTrados GroupShare server name, read from WebHookService settings.
ActionSdl.GroupShare.Events.V2.ProjectCreatedEvent
Example Message Body
{
      "Action": "Sdl.GroupShare.Events.V2.ProjectCreatedEvent",
      "ProjectName": "0430 - 1311",
      "ProjectId": "3b7755a7-9ad3-4541-824e-81f8accadbaa",
      "RaisedBy": "sa",
      "Server": "groupshare.local"
}

Phase Change Event

Headers
KeyValue
X-Correlation-IDCorrelation ID
Message Body
Property nameValue
ProjectIdProject ID
LanguageFileIdFile ID
PhaseJSON object that contains "id" and "name" members for phase id and phase name.
RaisedByEmail address of the user who triggered the event
ServerTrados GroupShare server name, read from WebHookService settings.
ActionSdl.GroupShare.Events.V2.PhaseChangeEvent
Example Message Body
{
  "Action": "Sdl.GroupShare.Events.V2.PhaseChangeEvent",
  "Phase": {
    "id": 22,
    "name": "Translation"
  },
  "LanguageFileId": "ce88d061-284c-4af6-9902-62c1b9e5decf",
  "ProjectId": "2a299c68-20c0-4bd3-87d0-a0d8c1490cf4",
  "RaisedBy": "sa",
  "Server": "groupshare.local"
}

Assignment Change Event

Headers
KeyValue
X-Correlation-IDCorrelation ID
Message Body
Property nameValue
ProjectIdProject ID
LanguageFileIdFile ID
FromCollection of users who were assigned before the assignment change.
ToCollection of user who are now assigned.
RaisedByEmail address of the user who triggered the event
ServerTrados GroupShare server name, read from WebHookService settings.
ActionSdl.GroupShare.Events.V2.AssignmentEvent
Example Message Body
{
  "Action": "Sdl.GroupShare.Events.V2.AssignmentEvent",
  "From": [
    {
      "userEmail": "sa"
    }
  ],
  "To": [
    {
      "userEmail": "pm"
    },
    {
      "userEmail": "sa"
    }
  ],
  "LanguageFileId": "ce88d061-284c-4af6-9902-62c1b9e5decf",
  "ProjectId": "2a299c68-20c0-4bd3-87d0-a0d8c1490cf4",
  "RaisedBy": "sa",
  "Server": "groupshare.local"
}

Check Out Change Event

Headers
KeyValue
X-Correlation-IDCorrelation ID
Message Body
Property nameValue
ProjectIdProject ID
LanguageFileIdFile ID
RaisedByEmail address of the user who triggered the event
ServerTrados GroupShare server name, read from WebHookService settings.
ActionSdl.GroupShare.Events.V2.CheckOutEvent
Example Message Body
{
  "Action": "Sdl.GroupShare.Events.V2.CheckOutEvent",
  "LanguageFileId": "ce88d061-284c-4af6-9902-62c1b9e5decf",
  "ProjectId": "2a299c68-20c0-4bd3-87d0-a0d8c1490cf4",
  "RaisedBy": "sa",
  "Server": "groupshare.local"
}

Check In Change Event

Headers
KeyValue
X-Correlation-IDCorrelation ID
Message Body
Property nameValue
ProjectIdProject ID
LanguageFileIdFile ID
RaisedByEmail address of the user who triggered the event
ServerTrados GroupShare server name, read from WebHookService settings.
ActionSdl.GroupShare.Events.V2.CheckInEvent
Example Message Body
{
   "Action": "Sdl.GroupShare.Events.V2.CheckInEvent",
   "LanguageFileId": "ce88d061-284c-4af6-9902-62c1b9e5decf",
   "ProjectId": "2a299c68-20c0-4bd3-87d0-a0d8c1490cf4",
   "RaisedBy": "sa",
   "Server": "groupshare.local"
 }