/
Webhook for OneList Events

Webhook for OneList Events

Source system can register an HTTP endpoint (Webhook) to receive OneList events. Event based integration is more timely and efficient than schedule-based integration.

OneList posts a simple notification message to the registered webhook endpoint. The source system uses the notification as a trigger to start the respective integration flow with OneList. OneList adapters should use the same integration flow for both event-based trigger and schedule-based trigger.

The notification JSON has the following information:

  • topic: source system name & event id

  • system: source system name

  • event: event id

{ "topic":"SAP/TaskAction", "system":"SAP", "event":"TaskAction"}

Task action event

  • Event id: TaskAction

This event is sent when a user actions a task in OneList. Upon receiving this event, OneList adapter should start the Task Action flow.

User sync event

  • Event id: UserSync

This event is sent when user mapping is required: task for a new user is received, or delegation is created, or task is forwarded. Upon receiving this event, OneList adapter should start the User Sync flow.

Delegation sync event

  • Event id: Delegation

This event is sent when user creates or maintains his/her task delegations in OneList. Upon receiving this event, OntList adapter should start the Delegation Sync flow.

Register Webhooks

Navigate to /comms/Config page then select the Webhooks tab.

Registering a webhook endpoint requires the following information:

  • The OneList source system name.

  • The webhook endpoint URL.

  • The method for OneList to authenticate with the webhook.

Authentication methods supported:

  • Anonymous.

  • OAuth - requires authorization URL and client credentials.

  • Http Headers - requires security header such as API key, auth cookie.

 

Related content

Event-driven data sync with Webhook
Event-driven data sync with Webhook
More like this
OneList Integration APIs
OneList Integration APIs
More like this
SAP Adapter Configuration Guide
SAP Adapter Configuration Guide
More like this
SAP Adapter Configuration Guide
SAP Adapter Configuration Guide
More like this
OneList Integration APIs
OneList Integration APIs
More like this
Source System API Specification
Source System API Specification
More like this