Notifications

Normally when events happens in the esignatur system the owner of a document is notified by email. Another choice is to get notified by a HTTP POST request to a URL of your choice.

One unified JSON message is posted. Depending on the type of event some of the fields may or may not be filled. The events are described below.

All events will have the NotificationMessageType, OrderId, DocumentReference and StepNumber fields set.

You can disable the Email and Identification fields by setting AnonymizeNotifications on the order to true. The field-keys will be sent but have empty content.

Failed notifications will be retried once pr. hour for up to 7 days.

Order Created

The OrderCreatedOwner message is sent when a new order is created in the system on your account.

JSON Input

{
  "NotificationMessageType": "OrderCreatedOwner",
  "OrderId": "d3c0698c-e5c4-4237-8489-d80a11c6d937",
  "OrderCustomData": "something you set when creating the order",
  "DocumentReference": "9asdfasdi99",
  "CustomerInvoiceNumber": "Ordre navn in Desktop App",
  "StepNumber": 1
}

Order Completed

The OrderCompletedOwner message is sent when the system has completed an order.

JSON Input

{
  "NotificationMessageType": "OrderCompletedOwner",
  "OrderId": "d3c0698c-e5c4-4237-8489-d80a11c6d937",
  "OrderCustomData": "something you set when creating the order",
  "DocumentReference": "9asdfasdi99",
  "CustomerInvoiceNumber": "Ordre navn in Desktop App",
  "StepNumber": 2
}

Order Expired

The OrderExpiredOwner message is sent when the system expires an order.

JSON Input

{
  "NotificationMessageType": "OrderExpiredOwner",
  "OrderId": "d3c0698c-e5c4-4237-8489-d80a11c6d937",
  "OrderCustomData": "something you set when creating the order",
  "DocumentReference": "9asdfasdi99",
  "CustomerInvoiceNumber": "Ordre navn in Desktop App",
  "StepNumber": 1
}

Order Signed

The OrderSignedOwner message is sent when a signer signs the order.

You will get one of these messages per signer signing the order.

When all signers have signed the order then a Order Complete message (see above) will be sent.

JSON Input

{
  "NotificationMessageType": "OrderSignedOwner",
  "OrderId": "d3c0698c-e5c4-4237-8489-d80a11c6d937",
  "OrderCustomData": "something you set when creating the order",
  "DocumentReference": "9asdfasdi99",
  "CustomerInvoiceNumber": "Ordre navn in Desktop App",
  "StepNumber": 1,
  "Email": "hermoine.g@æøå.info",
  "Identification": "123456-7890",
  "SignerReference": "xxxx",
  "SignerCustomData": "something else you set when creating the order"
}

Order Cancelled

The OrderCancelledOwner message is sent if a signer cancels the order - that is, refuses to sign the order.

The signer may specify a message. This message will be sent as well.

JSON Input

{
  "NotificationMessageType": "OrderCancelledOwner",
  "OrderId": "d3c0698c-e5c4-4237-8489-d80a11c6d937",
  "OrderCustomData": "something you set when creating the order",
  "DocumentReference": "9asdfasdi99",
  "CustomerInvoiceNumber": "Ordre navn in Desktop App",
  "StepNumber": 1,
  "Email": "hermoine.g@æøå.info",
  "Identification": "123456-7890",
  "RejectMessage": "Jeg kan ikke godkende aftalen. Den er ikke god for mig!"
}