Webhooks - Rest PKI Core

You may configure your Rest PKI Core subscription to send event notifications to your app. The following notifications are currently available:

Event type	Description
DocumentSignatureCompleted	Triggered when a document is signed and has finished being processed

If enabled, webhook notifications consist of HTTP POST requests with a WebhookEventModel. See the API Reference for the model schema.

A sample webhook notification of a DocumentSignatureCompleted event is shown below:

{
    "type": "DocumentSignatureCompleted",
    "document": {
        "id": "3dfdd6f0-884e-4092-abed-00f18ea6716a",
        "key": "FUFYQ7SL6XKMBW9A",
        "formattedKey": "FUFY-Q7SL-6XKM-BW9A",
        "originalFile": {
            "name": "P100001-001.pdf",
            "length": 101730,
            "contentType": "application/pdf",
            "location": "https://..."
        },
        "signedFile": {
            "name": "P100001-001.pdf",
            "length": 273429,
            "contentType": "application/pdf",
            "location": "https://..."
        },
        "status": "Completed",
        "signatureType": "Pades"
    }
}

When configuring webhook notifications, you must specify:

• The URL to which the HTTP request should be made
• Optionally, an authentication type
  • Basic: specify also a username and password, sent on the Authentication request header with schema Basic
  • Bearer: specify also a bearer token, sent on the Authentication request header with schema Bearer
  • API Key: specify also the API key to be sent on the X-Api-Key request header