Registering a Webhook Integration
Workfront administrators can add a custom webhook integration for their company by navigating to Setup > Documents > Custom Integrations within Workfront. From the Custom Integration page within Setup, administrators can view a list of existing document Webhook integrations. From this page, integrations can be added, edited, enabled, and disabled. To add an integration, click the “Add Integration” button.
When adding an integration, the administrator will enter values for the following fields.
|Name||The name of this integration.|
|Base API URL||
The location of the callback API. When making calls to the external system,Workfront will simply append the endpoint name to this address. For example, if the admin entered the Base API URL, “ https://www.mycompany.com/api/v1 ”, Workfront would using the following URL to get a document’s metadata: https://www.mycompany.com/api/v1/metadata?id=1234.
Optional values to be appended to the querystring of every API call. For example, access_type=offline.
|Authentication Type||OAuth2 or ApiKey|
(OAuth2 Only) The full URL used for user authentication. Workfront will navigate users to this address as part of the OAuth provisioning process. Note: Workfront will append a “state” parameter to the query string. The provider must pass this back to Workfront by appending it to the Workfront Redirect URI.
|Token Endpoint URL||
(OAuth2 Only) The full API URL used to retrieve OAuth2 tokens. This is hosted by the webhook provider or external document provider
|Client ID||(OAuth2 Only) The OAuth2 Client ID for this integration|
(OAuth2 Only) The OAuth2 Client Secret for this integration
|Workfront Redirect URI||(OAuth2 Only) This is a read-only field and is generated by Workfront. This value is used to register this integration with the external document provider. Note: As described above for Authentication URL, the provider must append the “state” parameter and its value to the querystring when performing the redirect.|
(ApiKey Only) Used to make authorized API calls to the webhook provider. The API key issued by the webhook provider.