View and manage custom apps in WorkDrive

1. To update the app details: Click on the app of your choice. This will open the corresponding App details page, where you can edit the app's name and description according to your requirements.
   
   
2. To delete the custom app: If you want to remove a custom app from your WorkDrive team, you can do so by clicking the Delete app button located at the bottom of the App details page for the specific app you wish to remove.
   
   

Notes:

1. You can create up to 10 webhooks for each custom app.
   
2. You can only make 50000K webhook calls/day.
   

1. Click Admin Console in the bottom-left corner. This will open the Admin Console window and the Dashboard tab will be selected by default.
   
2. Navigate to the Apps tab by clicking on it from the left pane. The Apps tab will appear on the right with the list of all your custom apps.
   
   
3. Choose the custom application for which you want to configure webhooks. This will open the Custom app window. The App details tab will be selected by default.
   
   
4. Switch to the Webhooks tab and click Create new webhook. This will open the Create new webhook window.
   
5. Provide the webhook name and description in the respective fields.
   
   
6. Enter the Endpoint URL to which you want to receive notifications.
   Note: Make sure the URL is active and capable of processing webhooks.
   
   
7. Select the trigger event (File, Folder, Team Folder, Org based) and specify the event's target location.
   Click here to learn more about the event types available in WorkDrive
   
   
8. Click Create Webhook.
   You will now receive notifications at the specified URL whenever the specified event occurs in WorkDrive.
   
   

Webhooks payload

{

  "data": [

    {

      "resource_info": {

        "parent_id": "lvwg28f94012d0a484328b6175c6da296b433",

        "resource_id": "ep19987f95a0161684d8ea1b3161f16e41e38",

        "resource_name": "Default App Migration Report.csv",

        "base_parent_id": "lvwg28f94012d0a484328b6175c6da296b433",

        "status": 1

      },

      "share_info": {

        "role": "7",

        "shared_type": "14",

        "shared_by": 5608329,

        "shared_status": 14,

        "shared_to": "111118000000038003"

      },

      "association_info": {

        "entity_value": "Guna",

        "entity_label": "record",

        "module": "Leads",

        "entity_id": "EID0000001011"

      },

      "event_id": "839687000000338003",

      "event_type": "file_create",

      "app_key": "1000.0UUMEY8E1WWRF26GF0XIHRLKDHHFNH",

      "webhook_id": "ep19987f95a0161684d8ea1b3161f16e41e38-839687000000335005",

      "module_name": "",

      "portal_id": "638722",

      "team_id": "lvwg26329e83825ed4815b2e685e1781d6728",

      "type": "event_callback",

      "event_time": 1600422715262,

      "event_by": 61184597

    }

  ]

}

Webhook authentication

1. It uses the shared secret key to sign and encode the Webhook payload.
2. It compares the resulting signature with the value sent in the X-ZWDWebhook-Signature header of the Webhook request.

Creation of HMAC Signature

The JWS header is as follows:

{

"alg": "HS256",

"typ": "JWT"

}

1. alg: HS256 algorithm is used to generate hashing signature.
2. typ: The typ (type) header parameter is used to declare the type of the signed content.
   

1. The JWT header and Webhook payload will be individually Base64 encoded, then joined together with a full stop “.”
   
   
2. Webhook signature is generated by hashing the Base64 encoded header and Base64 encoded Webhook Payload using SHA-256 algorithm and encode the resulting signature using Base64 encoding.
   
   
3. The three components, which are the Base64 encoded header, the Base64 encoded webhook payload, and the Base64 encoded HMAC SHA-256 signature, are concatenated together with full stops "." as separators.

X-ZWDWEBHOOK-SIGNATURE: <base64 header>.<base64 body>.<base64 HS256(<base64 header>.<base64 body>)

Verify the HMAC Signature

Note: All webhooks configured for a custom app use the same secret key for verifying the signature.

1. Click Admin Console in the bottom-left corner. This will open the Admin Console window and the Dashboard tab will be selected by default.
2. Navigate to the Apps tab by clicking on it from the left pane. The Apps tab will appear on the right with the list of all your custom apps.
3. Choose the custom app for which you need to copy the secret key. This will open the Custom app window and App details tab will be selected by default.
   
   Info: If you're already on the webhooks page, simply click the View secret key link on the right. This will take you to the corresponding App details tab.
   
   
4. Navigate to the secret key field within the App details tab and copy the value. You can now use the secret key for verifying webhooks.
   
   

1. Extract the webhook payload from the received webhook request.
   
   
2. Compute an HMAC signature for the webhook payload using the shared secret key. This involves using the SHA-256 hashing algorithm.
   
   
3. Encode the computed HMAC signature using the Base64 encoding mechanism.
   
   
4. Extract the signature from the X-ZWDWEBHOOK-SIGNATURE header of the webhook request.
   
   
5. Ensure that the computed Base64 encoded SHA-256 hash of the webhook payload matches the value provided in the X-ZWDWEBHOOK-SIGNATURE header of the webhook request.
   
   If there is a mismatch, reject the webhook request.

Note: Make sure that both the creation and verification mechanisms use the same encoding mechanism to ensure consistency and accurate verification of the webhook data.

View and manage webhooks in WorkDrive

1. Click Admin Console in the bottom-left corner. This will open the Admin Console window and the Dashboard tab will be selected by default.
   
   
2. Navigate to the Apps tab by clicking on it from the left pane. The Apps tab will appear on the right with the list of all your custom apps.
   
   
3. Choose the custom application for which you want to make changes to the webhooks. This will open the Custom app window. The App details tab will be selected by default.
   
   
4. Switch to the Webhooks tab to access the complete list of configured webhooks for your custom app, along with the respective manage options:
   
   
1. To enable or disable a webhook: Simply toggle the ON/OFF switch provided in the webhooks tab.
   
   
2. To modify the name and description of a webhook: Click the More actions icon and choose the Edit option.
   
   
3. To delete a webhook: Click the More actions icon and select Delete. Confirm the deletion by clicking Delete again in the confirmation dialog box.