File upload via Document Webhooks

Last update: November 7, 2023

CREATED FOR:

  • Developer

Uploading a file to a document storage provider is a two-step process that requires two separate API endpoints. Adobe Workfront begins the upload process by calling /uploadInit . This endpoint returns a document ID which is then passed to /upload when uploading the document bytes. Depending on the underlying document storage system, it might be necessary to create a zero-length document, then update the contents of the document later.

Added to version 1.1 of this spec, the document ID and document version ID can be used to retrieve extra information from Workfront.

Example: If the document management system wants extra information about the document, the webhook implementation code could use the document ID to retrieve that information using Workfront’s RESTful API. As a good practice, this information could come from custom data fields on the document and it’s containing task, issue, or project.

POST Method

URL

POST /uploadInit

Query Parameters

NameDescription
parentIdThe parent folder ID, as referenced by the webhook provider.
filenameThe name of the document
documentIdThe Workfront document ID (added in version 1.1)
documentVersionIdThe Workfront document version ID (added in version 1.1)

Response

The metadata for the file, as defined by the /metadata endpoint. This includes the document ID used by the provider.

Example:

https://www.acme.com/api/uploadInit?parentId=12345&filename=new-file.png&documentId=511ea6e000023edb38d2effb2f4e6e3b&documentVersionId=511ea6e000023edb38d2e ffb2f4e6e3b

PUT Method

Uploads the bytes of a document to the webhook provider.

URL

PUT /upload

Query Parameters

NameDescription
idThe document ID, which was just created.

Request Body

The raw content bytes for the document.

Response

{
result: "success"
}

or

{
result: "fail"
}

Example

https://www.acme.com/api/upload?id=1234 [document bytes included in update stream]

response

{
result:"success"
}

More help on this topic

Previous pageGet a thumbnail for a document
Next pageCreate a Folder with Document Webhooks

Workfront


Learn: Automating Workflows with Workfront Fusion - Unique Use Cases in Action

Workfront

Tuesday, Mar 4, 6:00 PM UTC

Looking for creative ways to use Workfront Fusion to solve business challenges? Join Pan Shahbazian of Starbucks as she shares three unique use cases that can transform your workflows.

Register

The Perfect Blend: A New Era of Collaboration with AEM and Workfront

Adobe Customer Success Webinars

Wednesday, Apr 2, 5:00 PM UTC

Explore how Adobe Experience Manager and Workfront integrate to help teams move from ideation to delivery without the usual bottlenecks, ensuring content is organized, on-brand, and ready to go live faster.

Register

Connect with Experience League at Summit!

Get front-row access to top sessions, hands-on activities, and networking—wherever you are!

Learn more

Register to learn something new

WORKFRONT

Join Adobe product experts in live events where you will learn Adobe Workfront best practices, tips and tricks, and hear about the latest product features and updates.

Register

Register now