Documentation Center

Using the Trados GroupShare WebHooks Service

Learn how to configure and use the Trados GroupShare WebHooks Service.

Configuring WebHooks Service

To configure the WebHooks service:

Procedure

  1. Go to C:\Program Files\SDL\SDL Server\WebHooks Service.
  2. Edit Sdl.GroupShare.WebHooksService.exe.config. The relevant settings are shown below:
    <appSettings>
      <add key="RestHostUrl" value="http://+:41239" />
      <add key="MessageQueueHost" value="localhost" />
      <add key="MessageQueueUserName" value="gssvc" />
      <add key="MessageQueueUserPassword" value="u5F/lWdnD+snwvYcjKv/Fg==" />
      <add key="WebHookQueueName" value="GsWebHookQueue" />
      <add key="WebHookQueueDeadLetterName" value="GsWebHookQueueDeadLetter" />
      <add key="WebHookQueueDLXName" value="GsWebHookDlx" />
      <add key="Server" value="gs-test-url.sdltest.com" />
      <add key="serilog:write-to:RollingFile.pathFormat" value="C:\ProgramData\SDL\Service\logs\WebHooks.Log" />
    </appSettings>
    <connectionStrings>
      <add name="MS_SqlStoreConnectionString" connectionString="Server=(local)\sqlserver2014;Database=WebHooks;Trusted_Connection=True;" providerName="System.Data.SqlClient" />
    </connectionStrings>
    Observe the configuration used for the service listening port, the RabbitMQ message queue and the database where the web hook registrations will be stored.
    • RestHostUrl The host and port setting that the Web Hooks Service will use to listen on.
    • MessageQueueHost, MessageQueueUserName, MessageQueuePassword are configured by the Trados GroupShare installer and are needed to consume messages from RabbitMQ.
    • WebHookQueueName, WebHookQueueDeadLetterName, WebHookQueueDLXName are used to specify the queues to consume messages from. It would be possible to create new queues with different routing keys. We recommend to leave as it is.
    • Server - the value of the Server setting will be included in the callback request body, to know the web hook sender of the message.

Subscribing to events

You can subscribe to all existing events by using the "*" filter and a single callback handling URL.

About this task

The available filter types are as follows:

  • Sdl.GroupShare.Events.V2.ProjectCreatedEvent
  • Sdl.GroupShare.Events.V2.PhaseChangeEvent
  • Sdl.GroupShare.Events.V2.AssignmentEvent
  • Sdl.GroupShare.Events.V2.CheckOutEvent
  • Sdl.GroupShare.Events.V2.CheckInEvent
  • *

Interacting with the REST API endpoint

Interaction with the Trados GroupShare WebHooks Service happens through REST API calls, secured with bearer tokens (that you get using Trados GroupShare Management Rest API login endpoint).

About this task

See REST API endpoint of WebHooks Service for more details.

Receiving 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.

About this task

See WebHooks Notifications (callbacks) for more details.

Testing REST API endpoints

To test / try Rest API endpoints, use the Postman collection .

About this task

Download and extract the ZIP file for collection.