הוספת Webhook ל-Doxi

על מנת שמערכת Doxi תדע לתקשר עם WSO2 (או מערכות אחרות), פותח מנגנון של Webhooks שמערכת Doxi שולחת מיד אחרי שקרתה פעולה במערכת, כגון סטטוס תהליך שהתשתנה, תהליך נחתם וכו'.
במקרים רבים נרצה ש-Doxi יפנה באמצעות webhook ל-API ב-WSO2 על מנת שיפעיל תהליך מסוים.
בכדי שנוכל לעשות זאת, יש תחילה להפעיל את ה-Webhook, מרגע הפעלת ה-Webhook – כל פעם שהפעולה שהגדרנו תתרחש, ישלח Webhook לכתובת שנקבעה.
להלן דוגמה להפעלת Webhook:

{
    "WebhookUri":"https://data.api-connect.co.il:8243/getSignFlowId",
    "isActive": true,
    "webhookEvents": [
    {
      "webhookEventType": 0,
      "signFlowEventFilter": 
        {
        "sourceTemplateId": "c4b63d9b-2184-43ee-9e84-ac9a8b468a6a"
        }
    }
  ]
}

• שדה "WebhookUri" מכיל את הכתובת אליה נפנה לאחר שהפעולה ב-Doxi התרחשה.
  כתובת זה אמורה להפנות ל-API ב-WSO2 שמתחיל תהליך כלשהו.
• שדה "isActive" – שדה בוליאני.
  ברגע שמוגדר "True" – תבוצע פניה מ-Doxi בכל פעם שארעה הפעולה בתנאים שהגדרנו.
  ברגע שמוגדר "False" – מערכת Doxi לא תבצע יותר פניות ל-API של WSO2.
• שדה "webhookEvents" – שדה זה מגדיר את הפעולה הנדרשת בצד Doxi ע"מ שלאחר מכן תעדכן את ה-API ב-WSO2.
  תיאור הפעולות קיים בדוקומנציה של ה-API תחת הסעיף של Webhook.
  https://apidocs.doxi-sign.com/#710c4f47-3ebb-494f-a45a-7e6d0323905b
  בדוגמה שלנו לעיל, Doxi תפנה אך ורק בעת שינוי סטטוס של תהליך השייך לתבנית המצוינת בלבד.

כך תראה פניית ה-Webhook ממערכת Doxi ל-WSO2: (במידה וה-Webhook הופעל תחילה)

{
  "Id": "79649877-78ce-41bf-a5ec-22678a0194f7",
  "WebhookEvent": "FlowStatusChangedEvent",
  "Attempt": 0,
  "Data": {
    "PreviousSignatureFlowStatus": "Open",
    "CurrentSignatureFlowStatus": "Approved",
    "StatusDateTime": "2023-04-30T06:37:20.3581813Z",
    "SignFlowId": "37d2a1b3-668d-41d8-8802-b739741a0ae0",
    "CustomFields": [],
    "SourceTemplateId": "c4b63d9b-2184-43ee-9e84-ac9a8b468a6a"
  },
  "CreationTimeUtc": "2023-04-30T06:37:20.6750347Z"
}