Webhooks Tab

Information

• In the Webhooks tab of the Administration, the webhooks of the system can be managed.

Access path

• Menu → Administration → Webhooks

Menu Item Webhooks

Menu → Administration → Webhooks → Webhooks

Information

• In a table, the webhooks of the system are listed with the following information:

  • ID

  • Title

  • Description

  • Endpoint

  • Author

  • Format

  • Enabled

  • Added on

• By default, the webhooks are sorted by their creation date, i.e. the newest webhooks are displayed at the top.

  • By clicking on the table headers, the table can be sorted by the individual criterion.

• The webhooks can be filtered by entering search terms in the fields of the first row.

• Via the buttons , and on the right side of the table, webhooks can be viewed, edited or deleted.

Create Webhook

Procedure

• Open the Administration panel → Webhooks.
• Click .
• Enter a Title for the webhook.
• If needed, enter a Description.
• Enter the Endpoint to which the webhook is supposed to send information.
• Select a Format.
  • Generic: unformatted (Default)
  • MS Teams: optimized for Microsoft Teams notifications
• Select the Type of the object to be watched.
• Enter the Object Id(s) of the objects to be watched.
  • If several IDs are entered, they need to be separated using commas.
• Select whether the activities of the object are to be watched.
• In the Activities to Be Watched field, enter the activities to be watched.
  • If nothing is entered, all activities of the object are watched.
• Select whether child elements are to be watched.
• If needed, specify which child elements are to be watched.
• If needed, specify which activities of the child elements are to be watched.

Detailed description of all parameters and activities

Edit Webhook

Procedure

• Open the Administration panel → Webhooks.

• Click on next to the webhook.

• Edit the description.

• Click Save.

Delete Webhook

Procedure

• Open the Administration panel → Webhooks.

• Click on next to the webhook.

• Confirm the dialog message.

Menu Item Webhook Messages

Menu → Administration → Webhooks → Webhook Messages

Information

• In a table, the messages sent by the webhooks of the system are listed with the following information:

  • ID

  • Webhook ID

  • Status

  • Send Attempts

  • Content

  • Result

  • Sent on

  • Added on

• Via the buttons and on the right side of the table, webhook messages can be viewed or deleted.

  • The messages will be deleted automatically after max. 2 minutes.