Notifications (webhooks)
Have Wipe call your systems when a certificate is issued or a proof is blocked. Client admins only.
A webhook makes Wipe send a message to one of your systems (ticketing, inventory, chat) whenever an event happens: no need to watch the portal. Client admins set them up in Settings → Notifications.
Events
| Event | Sent when |
|---|---|
| Certificate issued | A certificate is issued |
| Proof failed | A proof fails during processing |
| Proof rejected | A proof is rejected |
| Proof awaiting license | A proof waits because the organization has no license left |
| Proof abandoned | A proof is abandoned |
Create a webhook
Give the address
In Settings → Notifications, under New webhook, type the Endpoint URL: the HTTPS address of your system that will receive the events. It must be reachable from the Internet.
Choose the events
Tick the Events to send to this address.
Create it and copy the secret
Click Create webhook. The portal shows the signing secret once: copy it into the receiving system right away, it will not be shown again.
To stop the messages, click the delete button on the webhook and confirm. To change the address or the events, delete the webhook and create a new one.
What your system receives
Wipe sends an HTTP POST with a JSON body. For a certificate:
{
"notification_id": "7a1c...",
"tenant_id": "11111111-...",
"organization_id": "22222222-...",
"channel": "webhook",
"payload": {
"event": "certificate.issued",
"certificate_id": "5b0e...",
"organization_id": "22222222-...",
"tenant_id": "11111111-...",
"public_verification_code": "ABCD-EFGH-JKLM-NP"
}
}For a proof event (proof.failed, proof.rejected, proof.awaiting_license,
proof.abandoned), payload carries the proof_id, its status, its source and the reason.
Your system must answer with a 2xx status. On a 429 or 5xx answer, or when it cannot be
reached, Wipe tries again later, several times. Other answers are not retried.
Check the signature
Each message carries an X-Wipe-Signature header: sha256= followed by the HMAC-SHA256 of the
raw body, keyed with the signing secret. Recompute it and compare before trusting the message:
import hashlib
import hmac
def is_from_wipe(raw_body: bytes, header: str, secret: str) -> bool:
expected = "sha256=" + hmac.new(secret.encode(), raw_body, hashlib.sha256).hexdigest()
return hmac.compare_digest(expected, header)Compute it on the body exactly as received, before any JSON parsing. The X-Wipe-Notification-ID
header identifies the message: use it to ignore a message you have already processed.