Skip to main content

Payload Webhook

Für die drei Ereignisse werden folgende Payloads versendet:

Payload Veröffentlicht

Beispiel 1. JSON versendet für das Ereignis Veröffentlicht
{    
    "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"
}


Der Payload enthält folgende Daten:

  • event: Art des gemeldeten Ereignisses

  • resource_id: die ID des zuzuweisenden Elements

  • resource_title: Titel der veröffentlichten Publikation

  • format: das Format, in dem die Publikation veröffentlicht wurde

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

    Anmerkung

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

  • webhook_name: Name des verwendeten Webhooks

Payload Freigegeben

Beispiel 2. JSON versendet für das Ereignis Freigegeben
{    
    "event": "STATUS_SET_TO_RELEASED_EVENT",    
    "data": {        
        "resource_id": 1665639,        
        "resource_title": "Testpublication 2"    
    },    
    "webhook_name": "Silvio Webhook Test"
}


Der Payload enthält folgende Daten:

  • event: Art des gemeldeten Ereignisses

  • resource_id: die ID des freizugebenden Elements

  • resource_title: Titel des freigegebenen Elements

  • webhook_name: Name des verwendeten Webhooks

Payload Auftrag

Beispiel 3. JSON versendet für das Ereignis Auftrag
{    
    "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"
}


Der Payload enthält folgende Daten:

  • event: Art des gemeldeten Ereignisses

  • resource_id: die ID des zuzuweisenden Elements

  • resource_title: Titel des beauftragten Elements

  • language: die für den Auftrag ausgewählte Sprache

  • assignment_type: die Art des Auftrags (Beitrag, Prüfung, Übersetzung oder Übersetzungsprüfung)

  • startdate: das für den Auftrag festgelegte Startdatum

  • enddate: das Enddatum der für den Auftrag festgelegten Frist

  • startdate_timestamp: als Computercode dargestelltes Startdatum

  • enddate_timestamp: als Computercode dargestelltes Enddatum

  • assignment_link: direkter Link zum Auftrag

  • api: auf true oder false eingestellt, je nachdem, ob die API zum Auslösen des Ereignisses verwendet wurde oder nicht

  • webhook_name: Name des verwendeten Webhooks

Payload In Übersetzung

Beispiel 4. JSON versendet für das Ereignis Status auf „in Übersetzung“ gesetzt
{     
    "event": "STATUS_SET_TO_IN_TRANSLATION_EVENT",     
    "data": {         
        "resource_id": 10,          
        "resource_title": "Getting Started with Paligo"    
    },     
    "webhook_name": "TEST" 
}


Der Payload enthält folgende Daten:

  • event: Art des gemeldeten Ereignisses

  • resource_id: die ID des zu übersetzenden Elements

  • resource_title: Titel des auf „in Übersetzung“ gesetzten Elements

  • webhook_name: Name des verwendeten Webhooks

Payload In Prüfung

Beispiel 5. JSON versendet für das Ereignis Status auf „in Prüfung“ gesetzt
{     
    "event": "STATUS_SET_TO_IN_REVIEW_EVENT",     
    "data": {         
        "resource_id": 10,          
        "resource_title": "Getting Started with Paligo"     
    },     
    "webhook_name": "TEST" 
}


Der Payload enthält folgende Daten:

  • event: Art des gemeldeten Ereignisses

  • resource_id: die ID des zu prüfenden Elements

  • resource_title: Titel des auf „in Übersetzung“ gesetzten Elements

  • webhook_name: Name des verwendeten Webhooks