Come for answers. Stay for best practices. All we’re missing is you.
A webhook allows IBM Automation Document Processing to send real-time updates to other applications or services. When a specific event occurs—such as the completion of document processing—the system sends an HTTP POST request to a predefined URL.
Check document processing status for a larger document
Check training status logs – Monitor training progress overtime.
Error checks – Check causes of failed document upload, extraction training to debug further.
It is suggested to use lesser document types in a project, if more document types are needed it is recommended to split the project into multiple projects for a better webhooks and overall application experience.
If the document upload takes longer than expected, or has larger and/or heavier content like multiple images, it is recommended to try increasing memory limits and check the file uploads
If the webhook server doesn't receive any requests after uploading a document to ADP, the issue may lie in one of the following areas:
Ensure the webhook server URL is correctly configured in your ADP project settings.
Network or domain restrictions may block outbound requests. Check if ADP is allowed to send external requests via the OCP Operator settings for the webhook pod.
If configuration and network settings are correct, the issue may be with the webhook task itself. Check the webhook pod logs for detailed debugging. All major failures are logged in the sp-backend pod; hence this pod can be a primary location to check for error causes.
sp-backend
If you're encountering issues with a specific document upload, we recommend testing the document directly in the ADP Content Designer. This helps you understand how ADP is interpreting the document and can clarify whether the problem lies within ADP itself or is related to the webhook integration process.
By default, ADP is deployed with CA logging set to INFO. To access detailed webhook logs within the sp-backend pod, you'll need to switch the logging level to DEBUG. This provides deeper insights and can significantly aid in troubleshooting webhook-related issues.
INFO
DEBUG
ADP webhooks can be leveraged by using them in the below ways -
Notify users or systems when a document is processing is completed, or a status changes. Setup a ADP webhook that sends a data to a recruitment system when a resume is fully processed.
Keep data consistent across platforms by triggering updates automatically. When a new lead is added in a CRM, an ADP webhook can be setup to update the marketing automation platform that is already in place.
Trigger downstream workflows without manual intervention. After a document is approved in ADP, a webhook can be setup to trigger a downstream workflow like contract generation process.
Instantly alert security systems of suspicious activity or policy violations. ADP webhooks can also be used to notify the security dashboard when unauthorized access is detected.
Feed real-time data into analytics or monitoring tools. Webhooks can be configured to send event data to a dashboard when users interact with a document.
Seamlessly connect with external services like Slack, GitHub, or payment gateways. A webhook can be setup to post a message to Slack when a document is rejected or flagged.
Configuring your project settings: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0?topic=project-configuring-your-settings
Document Processing event webhooks: https://www.ibm.com/docs/en/cloud-paks/cp-biz-automation/25.0.0?topic=settings-document-processing-event-webhooks
Webhook site: https://github.com/webhooksite/webhook.site
Copy