Footer Section
Explore
Adobe Sign ServicesAdvantage Platform AdministrationApprovals for Advantage PlatformApprovals for SalesforceBilling for Advantage PlatformBilling for SalesforceCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceContractsConga for Google DocsConga Upgrade ProgramContract Intelligence (Standalone)Conga CopilotCPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceDiscovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformGridInvoice GenerationMix FormsOrchestrateOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceQuote GenerationSign for Advantage PlatformSign for SalesforceSmart SearchTest AuthorTurboEnginesX-Author for Contracts 1.0 (Classic)X-Author for ContractsX-Author for Contracts Advanced for Advantage PlatformX-Author for Contracts Advanced for SalesforceX-Author for ExcelX-Author for Migration Manager for Advantage PlatformX-Author for Migration ManagerRelease NotesGeneral
Update job status
post
https://IDD_URL/idd/api/{version}
/{tenantId}/analyze/status
Returns the status information for a given job or document. For requests with automatic notification enabled (that is, with a notificationInfo object included in the request), the notification in the request body resembles:
status: complete,
responseBody:
is_successful: true,
redirect_href: https://ca.app.kirasystems.com/platform-api/v1/downloads/3625/files,
downloadId: '3625'
job_id: '1928'
document_id: '83920'
Note: downloadId is only included if the job was an export.
tenantId
stringTenant name
context
stringStringified form of JSON representing the context from IDD
Examples:
{"recordType":"NDA","projectId":"557","instanceUrl":"https://www.conga.com"}
documentid
stringDocument ID
jobid
stringJob ID
userid
stringUser ID
Example:
a56392269d970c
username
stringUser name
Example:
dummyuser
Webhook information
notificationInfo
objectIncluding this webhook information enables automatic polling by IDD.
url
string<string>URL
Example:
https://www.conga.com/maxupload/notify
method
string<string>Request method
Example:
POST
:
:
::::::
curl --request POST \--url 'https://idd_url/idd/api/v2/tenantId/analyze/status?context=%7B%22recordType%22%3A%22NDA%22%2C%22projectId%22%3A%22557%22%2C%22instanceUrl%22%3A%22https%3A%2F%2Fwww.conga.com%22%7D' \--header 'Accept: application/json' \--header 'Content-Type: application/json' \--header 'X-API-Key: 123' \--data '{"notificationInfo": {"url": "https://www.conga.com/maxupload/notify","method": "POST"}}'
1{2"status": "in progress",3"responseBody": {4"retry_after": 15,5"job_status": "in-progress",6"last_update_time": "2021-01-19T22:52:20Z"7}8}
chevron_right