Subscriptions

For the WHL to be able to receive Webhook Notifications the connector registers following subscriptions:

• Agent Login

• Agent Logout

• Agent State Change

Request Flow

Initialize

Whenever the connector starts it makes the following requests to the Subscription API:

1. GET request on 'v2/event-types' (List Subscriptions)

2. If successful (v2 subscriptions are used):

   • GET request on 'v1/subscriptions' (List Subscriptions)

   • GET request on 'v2/subscriptions' (List Subscriptions)

   • If subscription exists on v1:

     • DELETE request on 'v1/subscriptions' (Delete Subscription)

   • If subscription exists on v2:

     • PATCH request on 'v2/subscriptions' (Update Subscription)

   • If subscription does NOT exist on v2:

     • POST request on 'v2/subscriptions' (Register Subscription)

3. If NOT successful (v1 subscriptions are used):

   • GET request on 'v1/subscriptions' (List Subscriptions)

   • If subscription does NOT exist:

     • POST request on 'v1/subscriptions' (Register Subscription)

   • If subscription exist:

     • PATCH request on 'v1/subscriptions' (Update Subscription)

List Subscriptions request is only made once, but other requests are made twice (one for the agent event subscription and second for the task event subscription).

Number of Requests: 3-4

Configuration Change

Whenever the connector configuration (Subscription section) is changed, the connector makes the following requests to the Subscription API:

1. If subscriptions were initialized for v1:

   • GET request on 'v1/subscriptions' (List Subscriptions)

   • If the match was found for a subscription name:

     • PATCH request on 'v1/subscriptions' (Update Subscription)

   • If the match was NOT found for a subscription name:

     • DELETE request on 'v1/subscriptions' (Delete Subscription)

     • POST request on 'v1/subscriptions' (Register Subscription)

2. If subscriptions were initialized for v2:

   • GET request on 'v2/subscriptions' (List Subscriptions)

   • If the match was found for a subscription name:

     • PATCH request on 'v2/subscriptions' (Update Subscription)

   • If the match was NOT found for a subscription name:

     • DELETE request on 'v2/subscriptions' (Delete Subscription)

     • POST request on 'v2/subscriptions' (Register Subscription)

List Subscriptions request is only made once, but other requests are made twice (one for the agent event subscription and second for the task event subscription).

Number of Requests: 2-3

Request Details

List Subscriptions

API Endpoint: /v1/subscriptions
API Endpoint: /v2/subscriptions
HTTP Verb: GET

Register Subscription

API Endpoint: /v1/subscriptions
API Endpoint: /v2/subscriptions
HTTP Verb: POST

Update Subscription

API Endpoint: /v1/subscriptions/{subscriptionId}
API Endpoint: /v2/subscriptions/{subscriptionId}
HTTP Verb: PATCH

Delete Subscription

API Endpoint: /v1/subscriptions/{subscriptionId}
API Endpoint: /v2/subscriptions/{subscriptionId}
HTTP Verb: DELETE