Task API

The use of API is subject to additional licenses. Please contact sales@documill.com for more information or a trial.

Dynamo Task API is the new asynchronous version of the previous compose API. It can be used to execute Dynamo Application Templates (DAP) and to monitor execution status.

Endpoint

Task API is available through base URI:

CODE

https://dynamo-api.documill.com/v1/task

API usage requires the following headers.

Headers

x-dynamo-tenant-id

Tenant/customer ID. Can be obtained through Dynamo license manager. When Salesforce is in use, tenant ID is the same as the Salesforce organization ID.

x-dynamo-api-key

API usage authorization key. Can be obtained through Dynamo support. Keep this key safe, together with tenant ID it enables access to the API. This key will change is a Salesforce organization refresh happens. After a refresh, a new key can be requested trough Dynamo support.

Integration

Task API can be integrated directly with Salesforce or it can be used standalone i.e. no connection to Salesforce.

Task start

Task is started using post task API.

Task status

Task status is available through status API.

Task completion

The task is ready when status response JSON “completed” property value is “true”. In case of errors, the status response JSON property “errors“ is also true.

Task completion can be monitored by polling task status. In case of Salesforce integration task template logic could send Salesforce platform event when task is ready. This way status polling is not required.

Task results

When Salesforce integration is in use, task template logic can save files, update records and create new records directly to Salesforce.

If Salesforce integration is not in use, resulting files can be stored as temporary files with store command and accessed through unique URL for one hour. Result file URLs can be read from task status response.

Monitoring

API tasks can be monitored through Dynamo customer console site. All posted tasks from last 3 days are visible in the console with status and possible error logs.

Send email to support@documill.com for further information.

Command restrictions

The following legacy compose API commands can’t be used: