Follow
Get information about the service (Not Yet Implemented)

(Release Date - TBD) Returns information about the service, such as features and capabilities. Workfront will use this information to customize the user interface in Workfront. For example, if the webhook implementation contains some custom actions, the JSON should list those operations in the JSON. Users would then be able to invoke these actions from Workfront.

URL

GET /serviceInfo

Query Parameters

None. In addition, calls to this endpoint should not require authentication.

Response

JSON containing information about this service

Name Type  Description
webhookVersion  String  The webhook version implemented by this service. This is the version number listed at the top of this spec.
version  String  The internal version number for this service. This number is determined by the webhook service provider and is used for informational purposes only.

publisher  String  The name of the company providing the webhook implementation.
availableEndpoints String  A list containing the API Endpoints implemented by this service. This may be used to ensure that the user interface in Workfront reflect the capabilities offered by the webhook provider. Each item in the list must include the name of the endpoint (such as “search”).
customActions  String  

A list containing the custom operations implemented by this webhook. Each list item includes a name and display name. The display name will appear in the “Document Actions” dropdown in Workfront. Clicking on the item in the dropdown will invoke the action in the webhook by calling the /customAction endpoint.

 

Example

https://www.acme.com/api/serviceInfo

returns

{

webhook version: “1.2”, version: “1.0”, publisher: “Acme, LLC”, availableEndpoints: [“files”, “metadata”, “search”, “download”

“thumbnail”, “uploadInit”, “upload” ], customActions [

{

name: “archive”, displayName: “Archive” }, {

name: “doSomethingElse”, displayName: “Do Something” }, ] }