Skip to main content

Webhook payload

The following payloads are sent for the various events:

Published payload

Example 1. 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

Released payload

Example 2. 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

Assignment payload

Example 3. JSON sent for the Assignment 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

In Translation payload

Example 4. 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 5. 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