Follow
Testing webhooks connection

To verify that your document webhook implementation works correctly, run the following tests. These are manual tests that go through the Workfront web interface and indirectly hit the endpoints for your webhook implementation.

Prerequisites

To run these tests you will need the following:

  • A Workfront account with Advanced Document Management (ADM) enabled
  • A Workfront user for this account with System Admin rights
  • A Document Webhook instance, who’s HTTP endpoints are accessible to Workfront

These tests also assume that you’ve already registered your Document Webhook instance in Workfront under Setup > Documents > Custom Integrations.

Test 1: Provision the Document Webhook service for a user

Tests the Authentication URL and Token Endpoint URL for OAuth-based Webhook providers.

  1. In Workfront, navigate to the main Documents page by clicking on the Documents link in the top navigation bar.
  2. Click on the Add Documents dropdown and select your Document Webhook service under Add Service.
  3. (OAuth services only) After completing the previous step, you will see your service’s OAuth2 authentication page load load in a popup window. (Note: you may be prompted to login to your service first.) From the authentication page, grant Workfront access to the user’s account by click the Trust or Allow button.
  4. Verify your service has been added to the Add Documents dropdown. If you don’t see it initially, try refreshing your browser.

Test 2: Link a document into Workfront Tests the following endpoints: /files, /metadata

  1. In Workfront, navigate to the main Documents page by clicking on the Documents link in the top navigation bar.
  2. Select your Document Webhook service under Add Documents.
  3. From the modal, navigate through the folder structure.
  4. Verify your able to navigate the folder structure properly.
  5. Select and link a document into Workfront

Test 3: Navigate to a document in the content management system

Tests the following endpoints: /metadata (specifically the viewLink)

  1. Link a document into Workfront
  2. Select the document and click the Open link.
  3. Verify that the document opens in a new tab.

Test 4: Navigate to a document in the content management system (with login)

Tests the following endpoints: /metadata (specifically the viewLink)

  1. Ensure that you are logged out of the content management system.
  2. Link a document into Workfront.
  3. Select the document and click the Open link.
  4. Verify that content management system’s login screen loads in a new tab.
  5. Login and verify that you’re taken to the document

Test 5: Download the document from the content management system

Tests the following endpoints: /metadata (specifically the downloadLink)

  1. Link a document into Workfront.
  2. Select the document and click the Download link.
  3. Verify that the download begins.

Test 6: Search for content

Tests the following endpoints: /search

  1. In Workfront, navigate to the main Documents page by clicking on the Documents link in the top navigation bar.
  2. Select your Document Webhook service under Add Documents.
  3. From the modal, perform a search.
  4. Verify that the search results are correct.

Test 7: Send document from Workfront to content management system

Tests the following endpoints: /files, /uploadInit, /upload

  1. In Workfront, navigate to the main Documents page by clicking on the Documents link in the top navigation bar.
  2. Upload a document to Workfront from your computer
  3. Navigate to the document details page
  4. From the Document Actions dropdown, select your Document Webhook service under Send To...
  5. Navigate to the desired destination folder and click the Save button.
  6. Verify that the document is uploaded to the correct location in the content management system.

Test 8: View Thumbnails in Workfront

Tests the following endpoints: /thumbnail

  1. Link a document into Workfront.
  2. Select the document in the list.
  3. Verify that the thumbnail appears in the right panel.

Test 9: Get the content bytes

Tests the following endpoints: /download

  1. Link a document into Workfront.
  2. Navigate to the document details page.
  3. Send the document to Workfront by selecting Document Actions > Send To... > Workfront. This will create a new document version in Workfront.
  4. Download the document from Workfront by clicking on the Download link.

Test 10: Refresh access token (OAuth2 Webhook providers only)

Tests the following endpoints: Token Endpoint URL

  1. Provision a the Document Webhook service for a user
  2. Invalidate the user’s access token by either 1 )waiting for it to timeout, or 2) invalidating it manually in the external system.
  3. Refresh the access token in Workfront. You can do this, for example, by linking a document into Workfront. You will know that the access token refreshed successfully if you were able to navigate to and link a document.

Note: Currently, the Send To... isn’t available for linked documents. This will be added by Workfront. You can test the /download endpoint by hitting the endpoint manually using a REST client, such as Postman. Alternatively, the /download endpoint can be tested by generating a digital proof. To enable, digital proofing please contact Workfront.