Webhooks

Sajnat API will send a webhook when important events occur in the application. In the dashboard you can specify an endpoint to receive these webhooks on.

You should use your API key as the secret when veryfing if the webhook request is valid. Do not trust an incoming webhook without checking the signature.

Code
 
<?php

$secret = env('SAJNAT_API_KEY');

$payloadJson = json_encode($payload);

$signature = hash_hmac('sha256', $payloadJson, $secret);

The webhook service will send a POST request to the user specified URL. The incoming webhook will also contain a header called Signature which should calculate the same hash as the $signature hash above.

List of events:

Signature requests

• Signature request created - signature_request_created
• Signature request sent - signature_request_sent
• Signature request received via email - signature_request_received
• Signature request visited (the subject has visited the signing portal) -signature_request_read
• Signature request bounced - signature_request_bounced
• OTP received (if ses signature type is set) - signature_request_otp_received
• Signature request signed - signature_request_signed

The payload of the above events will conform to the following structure:

Code
 
{
  "type": "signatureRequest",
  "event": "signature_request_sent",
  "data": {
    "uuid": "3b3d4afc-6459-4a55-84a8-7782ad25bd51",
    "signed": false,
    "options": {
      "body": "Hej Robb!\n\nDu har mottagit ett digitalt dokument för granskning.\nKlicka på knappen för att öppna dokumentet.",
      "subject": "Signeringsförfrågan"
    },
    "signature_type": "ses",
    "sent_at": "2022-06-30T10:20:13.000000Z",
    "received_at": null,
    "bounced_at": null,
    "read_at": null,
    "reminder_sent_at": null,
    "signed_at": null,
    "locale": "sv",
    "status": "waiting",
    "updated_at": "2022-06-30T10:20:05.000000Z",
    "created_at": "2022-06-30T09:36:27.000000Z"
  }
}

Documents

• Document sealed. When all subjects have signed the agreement - document_sealed

Code
 
{
  "type": "document",
  "event": "document_sealed",
  "data": {
    "agreement_document_name": "NDA.pdf",
    "agreement_thumbnail": "https://api.test.sajnat.se/632bf5e8-58a3-4856-9095-4941ebc2dedc/tmp92cb563b-9713-4213-86bd-20b337559d10-thumb.png",
    "created_at": "2022-06-30T13:52:31.000000Z",
    "created_by": 55,
    "finger_print": "0a673ee4",
    "locale": "sv",
    "name": "Dokument 2022-06-30",
    "private": false,
    "sent_at": "2022-06-30T13:53:01.000000Z",
    "short_name": "Dokument 2022-06-30",
    "signature_term": "bank_id",
    "signature_type_id": 2,
    "status": "sealed",
    "updated_at": "2022-06-30T13:56:05.000000Z",
    "user_tz": "2022-06-30 15:52:31 CEST",
    "uuid": "92cb563b-9713-4213-86bd-20b337559d10",
    "options": {
      "automatic_reminders": false,
      "specific_sign_order": false
    },
    "_links": [
      {
        "rel": "self",
        "uri": "/api/documents/92cb563b-9713-4213-86bd-20b337559d10"
      }
    ]
  }
}

Note If you require more events to be fired via webhooks, do not hesitate to get in touch. We'll be happy to help you integrate Sajnat into your workflow! info@sajnat.se