Integrations

8 min read

Webhooks

A webhook is a tool that allows you to set an event in Paligo to trigger events in another application. This is only possible if the other application also supports webhooks. For example, you could use a webhook to update a ticket in JIRA when a Paligo publication is published.

At the moment, Paligo supports webhooks for these events:

  • Status of a resource is set to Released

  • Publication is Published.

  • An Assignment is created

  • An Assignment is Approved.

  • Status of a resource is set to In Translation

  • Status of a resource is set to In Review

  • The status of an assignment has changed (Assignment user status changed)

The information that Paligo sends is similar to a notification. It contains basic information such as the ID of the publication or topic, the title, the name of the template (if appropriate), and the type of event that has happened in Paligo. This is sent as JSON to a URL that you provide for the external application. Your developers will need to configure your external application to receive and use the webhook data.

Create a webhook

To create a webhook:

  1. Set up your external application to receive webhooks. Paligo can only send updates to applications that allow webhooks.

    Refer to the application's official documentation for instructions.

  2. Get the following information for your external application:

    • URL to use for receiving webhooks from Paligo

    • Login details (if a login is required).

      Paligo supports OAuth logins and basic logins (user name and password).

  3. In Paligo, display the Integrations and Webhooks tab:

    1. Sign in to Paligo using a user account that has administrator permissions.

    2. Select the avatar in the top-right corner.

    3. Select Settings from the menu.

    4. Select the Integrations and webhooks tab.

  4. Select the Webhooks tab.

  5. Select Add webhook to create a new webhook.

    Alternatively, you can edit an existing webhook. Select the dotted menu ( ... ) for the webhook and then select Edit.

    Paligo displays the Add webhook dialog or Edit webhook dialog. They contain the same settings.

  6. Enter the Webhook name.

    Give it a name that is meaningful and that makes it easy for other users to understand its purpose.

  7. Enter the Webhook URL.

    This is the destination addressof your external application for the webhook.

  8. Enter a Webhook description [optional].

    Enter a meaningful description of the webhook so that other users can easily understand the purpose of the webhook.

  9. Choose the type of Authentication required for logging in to the external application.

    • None

    • OAuth

      If you choose OAuth, you also need to enter the Token.

    • Basic

      If you choose Basic, you also need to enter the Username and Password.

  10. Use Send on events to choose when Paligo will use a webhook to contact the other application.

    Choose from:

    • Status set to Released

    • Publication published

    • Assignment created

    • Status set to in translation

    • Status set to in review

    Note

    You can choose one event, multiple events, or no events. Choosing no events can be useful if you want to keep the webhook configuration, but don't want it to trigger any events. For example, if you are setting up webhooks that you will use in the future.

  11. To get an idea of what information Paligo will send, have a look at the Payloads page.

  12. Select Test webhook to check that Paligo can use the webhook successfully.

    You can use the information in the Payloads section to get an idea of what information Paligo will send.

  13. Select Add webhook to add your new webhook.

  14. Configure your external application to use the information that Paligo sends as a webhook. You can use the example in Paligo's webhook editor to get an idea of what information Paligo will send.

    Refer to the application's official documentation for instructions.

Edit a webhook

To edit an existing webhook:

  1. In Paligo, display the Integrations and Webhooks tab:

    1. Sign in to Paligo using a user account that has administrator permissions.

    2. Select the avatar in the top-right corner.

    3. Select Settings from the menu.

    4. Select the Integrations and webhooks tab.

  2. Select the Webhooks tab.

  3. Find the webhook that you want to edit, select its dotted menu (...) and then select Edit.

  4. Edit the webhook.

  5. Select Edit webhook to save your changes.

Delete a Webhook

To remove a webhook that you no longer need:

  1. In Paligo, display the Integrations and Webhooks tab:

    1. Sign in to Paligo using a user account that has administrator permissions.

    2. Select the avatar in the top-right corner.

    3. Select Settings from the menu.

    4. Select the Integrations and webhooks tab.

  2. Select the Webhooks tab.

  3. Find the webhook that you want to remove, select its dotted menu ( ... ) and then select Delete.

  4. Select Delete to confirm you want to remove the webhook.

Webhook payload

The following payloads are sent for the various events:

Released payload
Example 75. JSON sent for the Released event
{    
    "event": "STATUS_SET_TO_RELEASED_EVENT",    
    "data": {        
        "resource_id": 1665639,        
        "resource_title": "Testpublication 2"    
    },    
    "webhook_name": "Silvio Webhook Test"
}

The following data is contained in the payload:

  • event: type of event being reported

  • resource_id: the ID of the item being released

  • resource_title: title of the item that was released

  • webhook_name: name of the webhook used

Published payload
Example 76. JSON sent for the Published event
{    
    "event": "PUBLISHED_EVENT",    
    "data": {        
        "resource_id": 1665635,        
        "resource_title": "Testpublication",        
        "format": "pdf",
        "archive_link": "https:/test.paligoapp.net/path/to/zip-file.zip"    
    },    
    "webhook_name": "Silvio Webhook Test"
}

The following data is contained in the payload:

  • event: type of event being reported

  • resource_id: the ID of the item being assigned

  • resource_title: title of the publication that was published

  • format: the format the publication was published in

  • archive_link: URL to the zipped output file that was published

    Note

    This link will only be included if the Save output in Paligo setting was checked in the publish settings.

  • webhook_name: name of the webhook used

Assignment created payload
Example 77. JSON sent for the Assignment created event
{    
    "event": "ASSIGNMENT_CREATED_EVENT",    
    "data": {        
        "resource_id": 1665712,        
        "resource_title": "Admonitions",        
        "language": "en",        
        "assignment_type": "review",        
        "startdate": "Monday 17/02/2025",        
        "enddate": "Monday 24/02/2025",        
        "startdate_timestamp": 1739833201,        
        "enddate_timestamp": 1740438001,        
        "assignment_link": "https://your.paligoapp.com/document/review/1665712/lang/en/#/assignment/282",        
        "api": false    
    },    
    "webhook_name": "Webhook Title"
}

The following data is contained in the payload:

  • event: type of event being reported

  • resource_id: the ID of the item being assigned

  • resource_title: title of the item that was assigned

  • language: the language that was selected for the assignment

  • assignment_type: the type of assignment (Contribution, Review, Translation or Translation review)

  • startdate: the starting date set for the assignment

  • enddate: the date for the deadline set for the assignment

  • startdate_timestamp: start date represented as computer code

  • enddate_timestamp: end date represented as computer code

  • assignment_link: direct link to the assignment

  • api: set to true or false, depending on whether or not the API was used to trigger the event

  • webhook_name: name of the webhook used

Approved payload
Example 78. JSON sent for Approved event
{
    "event": "ASSIGNMENT_APPROVED_EVENT",
    "data": {
        "resource_id": "",
        "resource_title": "",
        "language": "",
        "assignment_type": ""
    },
    "webhook_name": ""
}

The following data is contained in the payload:

  • event: type of event being reported

  • resource_id: the ID of the item being released

  • resource_title: title of the item that was released

  • language: the language that was selected for the assignment

  • assignment_type: the type of assignment (Contribution, Review, Translation or Translation review)

  • webhook_name: name of the webhook used

In Translation payload
Example 79. JSON sent for the Status set to in translation event
{     
    "event": "STATUS_SET_TO_IN_TRANSLATION_EVENT",     
    "data": {         
        "resource_id": 10,          
        "resource_title": "Getting Started with Paligo"    
    },     
    "webhook_name": "TEST" 
} 

The following data is contained in the payload:

  • event: type of event being reported

  • resource_id: the ID of the item being translated

  • resource_title: title of the item that was set to in translation

  • webhook_name: name of the webhook used

In Review payload
Example 80. JSON sent for the Status set to in review event
{     
    "event": "STATUS_SET_TO_IN_REVIEW_EVENT",     
    "data": {         
        "resource_id": 10,          
        "resource_title": "Getting Started with Paligo"     
    },     
    "webhook_name": "TEST" 
}

The following data is contained in the payload:

  • event: type of event being reported

  • resource_id: the ID of the item being reviewed

  • resource_title: title of the item that was set to in translation

  • webhook_name: name of the webhook used

Assignment user status changed payload
Example 81. JSON sent for Assignment user status changed event 
{
  "event": "ASSIGNMENT_USERSTATUS_CHANGED",
  "data": {
    "resource_id": 1545761,
    "resource_title": "title of the resource",
    "language": "en",
    "assignment_type": "contribution",
    "status": ""
  },
  "webhook_name": "new"
}

The following data is contained in the payload:

  • event: type of event being reported

  • resource_id: the ID of the item being assigned

  • resource_title: title of the publication that was published

  • language: the language that was selected for the assignment

  • assignment_type: the type of assignment (Contribution, Review, Translation or Translation review)

  • status: the new status of the assignment (e.g. Done, or Needs work)

  • webhook_name: name of the webhook used