Search via Document Webhooks

Last update: November 7, 2023

CREATED FOR:

  • Developer

Returns metadata for the files and folders returned from a search. This can be implemented as a full-text search or as a regular database query. Adobe Workfront calls the /search endpoint when the user performs a search from the external file browser.

URL

GET /search

Query Parameters

NameDescription
queryThe search term or phrase.
parentId(optional) The folder ID from which the search executed. Note: This is a placeholder for a future feature in Workfront. Currently, workfront does not pass this parameter.
maxThe maximum number of items to return. Used for pagination.
offsetThe page offset, used in conjunction with 'max'.

Response

JSON containing a list of metadata for files and folders matching the query. What constitutes a “match” is determined by the webhook provider. Ideally, it should do a full-text search. Doing a filename-based search also works.

Example:

Example: https://www.acme.com/api/search?query=test-query

[
{ File/Folder Metadata },
{ File/Folder Metadata }
]
Previous pageGet item list of folder contents
Next pageGet document content via Webhooks

Workfront