Skip to main content

[en] Webhooks

[en] 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.

[en] At the moment, Paligo supports webhooks for these events:

  • [en] Status of document is set to Released

  • [en] Publication is Published.

  • [en] An Assignment is created

[en] 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.

[en] Create a webhook

[en] To create a webhook:

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

    [en] Refer to the application's official documentation for instructions.

  2. [en] Get the following information for your external application:

    • [en] URL to use for receiving webhooks from Paligo

    • [en] Login details (if a login is required).

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

  3. Rufen Sie in Paligo die Registerkarte Integrationen oder Integrationen und Webhooks auf:

    1. Melden Sie sich bei Paligo über ein Benutzerkonto mit Administratorberechtigungen an.

    2. Wählen Sie den Avatar in der oberen rechten Ecke aus. User avatar. It shows the user's image and their name. Next to the name is a downward pointing arrow, which when selected, reveals a menu.

    3. Wählen Sie im Menü Einstellungen aus. Cog icon.

    4. Wählen Sie die Registerkarte Integrationen. Jigsaw piece icon.

      Paligo settings. The Integrations and Webhooks tab is highlighted.

  4. [en] Select the Webhooks tab.

  5. [en] Select Add webhook to create a new webhook.

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

    Add webhook dialog. It has settings for the webhook name, webhook url, webhook description, authentication, send on events. It also has a JSON preview and options to test webhook, close, and add webhook.
    Edit webhook dialog. It has settings for the webhook name, webhook url, webhook description, authentication, send on events. It also has a JSON preview and options to test webhook, close, and edit webhook.

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

  6. [en] Enter the Webhook name.

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

  7. [en] Enter the Webhook URL.

    [en] This is the destination addressof your external application for the webhook.

  8. [en] Enter a Webhook description [optional].

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

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

    Authentication setting for webhooks. It has radio buttons for None, OAuth, and Basic.

    • [en] None

    • [en] OAuth

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

    • [en] Basic

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

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

    Webhooks_Send_on_Events_Dropdown.png

    [en] Choose from:

    • [en] Status set to Released

    • [en] Publication published

    • [en] Assignment created

    Anmerkung

    [en] 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. [en] To get an idea of what information Paligo will send, have a look at the Payloads page.

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

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

  13. [en] Select Add webhook to add your new webhook.

  14. [en] 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.

    [en] Refer to the application's official documentation for instructions.

[en] Edit a webhook

[en] To edit an existing webhook:

  1. Rufen Sie in Paligo die Registerkarte Integrationen oder Integrationen und Webhooks auf:

    1. Melden Sie sich bei Paligo über ein Benutzerkonto mit Administratorberechtigungen an.

    2. Wählen Sie den Avatar in der oberen rechten Ecke aus. User avatar. It shows the user's image and their name. Next to the name is a downward pointing arrow, which when selected, reveals a menu.

    3. Wählen Sie im Menü Einstellungen aus. Cog icon.

    4. Wählen Sie die Registerkarte Integrationen. Jigsaw piece icon.

      Paligo settings. The Integrations and Webhooks tab is highlighted.

  2. [en] Select the Webhooks tab.

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

    Webhooks_Edit_Webhook.png

  4. [en] Edit the webhook.

  5. [en] Select Edit webhook to save your changes.

[en] Delete a Webhook

[en] To remove a webhook that you no longer need:

  1. Rufen Sie in Paligo die Registerkarte Integrationen oder Integrationen und Webhooks auf:

    1. Melden Sie sich bei Paligo über ein Benutzerkonto mit Administratorberechtigungen an.

    2. Wählen Sie den Avatar in der oberen rechten Ecke aus. User avatar. It shows the user's image and their name. Next to the name is a downward pointing arrow, which when selected, reveals a menu.

    3. Wählen Sie im Menü Einstellungen aus. Cog icon.

    4. Wählen Sie die Registerkarte Integrationen. Jigsaw piece icon.

      Paligo settings. The Integrations and Webhooks tab is highlighted.

  2. [en] Select the Webhooks tab.

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

    Webhooks_Delete_Webhook.png

  4. [en] Select Delete to confirm you want to remove the webhook.