Event-driven data sync with Webhook

Source system can register Webhook with OneList to receive events and implement event-based data synchronization with OneList.

Prerequisites

  • OneList v8.0 and later.

  • The webhook endpoint accepts HTTP POST request and is accessible by OneList.

Webhook registration

  • Navigate to /comms.

  • Select the Configuration > Webhooks to open the Webhook registration page and add the webhook:

    • System: the name of the source system.

    • URL: the webhook endpoint URL.

    • Authentication: select the authentication option for the webhook connection:

      • Anonymous.

      • OAuth: provide the token endpoint, client ID and client secret.

      • HttpHeaders: provide the required HTTP header and value, e.g. Authorization: <auth-scheme> <authorization-parameters> or other custom headers.

Event notifictions

OneList raises the following events. The source system can selectively handle the event it wishes to support.

  • TaskAction

  • UserSync

  • TaskRefresh

  • Delegation

OneList posts the JSON below to the webhook endpoint:

  • topic: System/Event ID

  • system: the source system name

  • event: the event ID

for example:

{ topic = SAP/TaskAction, system = SAP, event = TaskAction }