Integrations
Webhooks
Events pushed to your systems when a document is processed, a review completes or an approval changes.
What moves
What PTAS AI tells your systems, and when
Something changes on our side: a record is ready, a reviewer finishes, an approver decides. Your endpoint hears about it as it happens, and your system takes the next step without asking every minute.
DocPro processing
Your review queue
FinSuite approvals
PTAS AI
A notification at your endpoint
A message over HTTPS naming the event and the record it concerns, sent as it happens.
The current record, read by reference
Your system fetches the record through the REST API when it needs the detail.
The next step in your systems
A posting, a ticket, a status change in your portal, started by the event instead of a timer.
Event names, payload fields, delivery verification and the handling of failed deliveries are defined in the developer documentation issued with API access. The examples on this page are illustrative.
Submitting documents: the REST APIIntegration methods
Push, poll, file or platform
Four ways to hear about a change. Which one fits is mostly a question about your network.
Native
The other system's own events
Some systems you connect, QuickBooks and Zoho among them, send webhooks of their own when a record changes. Those are covered on each system page. This page is about the events PTAS AI sends to you.
API
Webhooks, with polling as the fallback
PTAS AI calls an HTTPS endpoint you register when an event you subscribed to happens. Where your network does not accept inbound calls, the same status can be read through the REST API with your reference.
File
A scheduled results file
For systems that can neither receive calls nor make them, results and status can go out as a file to a folder or an SFTP location on a schedule. Expect hours between an event and the file that reports it.
Custom
Your integration platform
If an integration platform or a message queue already sits between your systems, point the webhook at it, so routing and monitoring stay where your team already watches them.
A webhook needs an endpoint PTAS AI can reach over HTTPS, which in many finance environments means a gateway your security team has to approve. Where that is not allowed, polling with your reference gives the same answer a few minutes later, and for a workflow where review takes a morning, the difference hardly shows. What a webhook saves is the job that would otherwise ask every minute whether a document is done.
Illustrative example · one invoice, four events
Illustrative data. Which events you receive is agreed per workflow: a team that lets FinSuite post to the ERP may only want the last one.
Event mapping
What each event tells you, and what to do with it
Three event families, and the two things every event carries. The subscription for your workflow is agreed before go-live.
Illustrative example · a review-completed event
Illustrative example. Event names, payload fields and how a delivery is verified are set out in the developer documentation issued with API access.
Acknowledge first
Answer straight away, then do the work. A slow reply looks like a failure from the other side.
Expect repeats
Keep the event reference and ignore one you have already handled.
Read, then act
Treat the event as a prompt and act on the current record, whatever order events arrive in.
Security of the connection
What protects the events your endpoint receives
Four controls, split between our side and yours. A webhook endpoint is a door into your systems, and it deserves the same review as any other.
HTTPS endpoints only
Events go to HTTPS endpoints you register. Adding or changing an endpoint is a configuration change with an owner, recorded like any other change to a workflow.
Agree how a delivery is verified
Before go-live, settle with us how your endpoint confirms an event came from PTAS AI, using the method in the developer documentation, and check it on every delivery. Reject and log anything that fails.
Only the fields a destination needs
Where an event carries field values, masking is set per field and per destination, so an identity number need not reach a system that only needs to know the status.
Every event on the record
Each event sent is kept in the audit trail with the record it concerns, so a question about what your system was told, and when, has an answer.
FAQ
Questions developers ask about webhooks
What events can we subscribe to?
The families on this page: document processed, review completed and approval changed. The exact event names and payloads are in the developer documentation issued with API access, and which ones you receive is agreed per workflow.
What if our endpoint is down?
Design for it either way. Keep the reference for every document in flight, and when your endpoint is back, read the current status of each through the REST API. How undelivered events are handled on our side is set out in the developer documentation.
Can the same event arrive twice?
Plan for it. Any webhook system can deliver an event more than once, or out of order, when networks misbehave. Keep the event reference, ignore one you have already handled, and act on the current record, whatever order events arrived in.
Do we need webhooks at all?
No. Polling with your reference through the REST API gives the same answers, a little later. Webhooks earn their place when review can take hours and you would rather not run a job that asks every minute whether a document is done.
Our network does not accept inbound calls. What then?
Poll instead, or point the webhook at a gateway or integration platform your security team already runs. With on-premise or air-gapped deployment, where supported, the endpoint sits inside the same network as the platform.
Keep reading
Related reading
REST API Integration
Submit documents, receive structured results and start workflows from your own applications.
Read more →DocPro API
Documents in, structured JSON with field-level confidence out, in more detail.
Read more →Human-in-the-loop guide
How review thresholds work, and why a held field is a control.
Read more →All integrations
ERPs, accounting suites, the REST API and webhooks in one list.
Read more →Developers
Tell us which events your systems need
Name the workflow and the system that should react to it. API access comes with the developer documentation for events and payloads, set up for your account.