Webhooks

In this area, you can specify whether signoSign/2 sends a “webhook” when certain events occur.

For signoSign/2, a webhook is an HTTP request that is sent by signoSign/2 to a specific URL. The body of this request contains a JSON object with information about the event that has occurred, the user and the document. The receiving application can respond to this webhook.

The webhook is particularly useful when combined with a web application, e.g. via the URL scheme, so that the web application is informed when the document is completed.

signoSign/2 sends the webhook once and does not expect or react to a response. The webhook is only used for one-way communication with a third-party system to provide information about an event.

General

The “general” area is used to define the events for which the webhook should be sent.

The following events are available:

Option	Description
Archiving successful	Defines a URL to which a webhook is sent when the document has been successfully archived.
Archiving not successful	Defines a URL to which a webhook is sent if the document could not be archived. This webhook is only sent if there is a permanent (“hard”) error, e.g. because the archiving path is not available. In the event of a “soft” error, e.g. if not all mandatory signatures have been provided, no webhook is sent.
Closing without archiving	Defines a URL to which a webhook is sent when the document has been closed without being archiving.

If signoSign/2 is terminated unexpectedly, no webhook is sent.

Example webhook

The following example shows the JSON object of a webhook that is sent when archiving is successful:

JSON

{
    "Event": {
        "TimeStamp": "2024-04-11T11:51:37.8801444+02:00",
        "EventType": "ArchivingSucceeded",
        "EventCode": 100,
        "Software": {
            "Name": "signotec signoSign/2",
            "Version": "11.8.1"
        },
        "User": {
            "UserName": "example.user",
            "MachineName": "EXAMPLE-PC"
        },
        "EventData": {
            "Document": {
                "DocumentName": "Test.pdf",
                "DocumentType": "Test",
                "SignatureFields": 2,
                "MandatoryFields": 1,
                "SignedSignatureFields": 1,
                "SignedMandatoryFields": 1
            },
            "Placeholder": [
                {
                    "Name": "Variable1",
                    "Label": "Name",
                    "Value": "Example Name"
                },
                {
                    "Name": "Variable2",
                    "Label": "Phone Number",
                    "Value": "+49 1234567890"
                }
            ]
        }
    }
}