Integrations

Webhooks

The settings for Webhooks can be accessed through the Integrations section. Within the Webhooks menu item, these can be created and managed.

First, enter a name for the webhook. This name will always be transmitted when the webhook is triggered. Providing an (authentication) token is optional; the requirement depends on the security policies of the target server. The URL should be entered as the target address to which the notification about a triggered element (event) will be sent.

By assigning elements in the Triggers category, you can determine which objects should receive change notifications.

Triggers will only be updated by the system upon successful logout/login.

The system transmits the following parameters to the target address.
For the action property, the following distinctions are made:

CREATE
UPDATE
DELETE

The properties endpoint and id provide information about the affected record. With this information, additional details can be retrieved via the API if needed.

Example Output


{

    "5": {

     "webhook": "Example",

     "action": "CREATE",

     "endpoint": "accounts",

     "id": "1",

     "client": "00000"

    }

}