In this lesson you
- Learned what a webhook is, and who builds each side
- Saw the eight events Proof can tell your systems about
- Added an endpoint, kept the signing secret, and watched a test delivery land
Transcript
Connect your systems
Webhooks: hear when work finishes. Your team already works in other systems, like a ticketing tool, or a channel in Teams or Slack. So how do those systems find out that a document was certified, or sent back, without someone watching Proof all day? A webhook does that. It's a short message Proof sends to an address in your own systems, the moment something happens. Your developers build what receives it. You set it up here, on the Developer page in Admin.
What you can hear about
Let's start with what Proof can tell you. Most events follow a document through its work. You can hear when a document is assigned to someone, when it's ready for approval, and when it's sent back with changes. You can also hear when it's certified, when it's escalated, and when a certified document is re-opened for review. Two events cover larger jobs. One says an import has finished analyzing, and one says a remediation run has finished.
Adding an endpoint
To set one up, choose Add endpoint. An endpoint is the web address your developers give you for receiving these messages. Paste it under Endpoint URL. Then tick only the events your system needs, and choose Create webhook. Proof now shows a signing secret, once. Copy it, and pass it to your developers. Every message carries a signature made with that secret. It lets their system check that the message really came from Proof, and wasn't changed on the way. The details they need are under Verifying a delivery.
Is it working?
Before you rely on it, check that messages arrive. Open the actions menu on the endpoint, and choose Send test event. Then choose Deliveries. The log shows each message, its event and whether it was received. OK means your system accepted it. Failed means it didn't, and the Error column says why. If a message fails, Proof tries it up to three times. After ten failed deliveries in a row, it turns the endpoint off and emails your admins, so a broken receiver doesn't go unnoticed. Once your developers fix it, turn the endpoint back on with its switch. The same switch pauses it while they work on it. To change what it hears about, choose Edit events in the same menu. Now you can connect your own systems to Proof, so your team hears about finished work where they already are.
Recap
That's the end of the administrators track. Thanks for watching.
Maple Ridge Community Health, its documents and its people are fictional, made for these lessons.