Organization-level webhooks are designed to generate notifications at the organization-level whenever specific events occur. For example, when a Book is verified within your organization, regardless of the number of API accounts, we will send the relevant payload to the configured webhook URL(s).

The purpose of this type of webhook is to provide a centralized and consolidated notification system for important events within your organization. Instead of configuring URLs for each individual account, you have the flexibility to set a single URL that will handle notifications for all accounts within your organization. This approach ensures efficiency and eliminates unnecessary duplication of notifications.

By leveraging this webhook, you can effectively monitor and respond to critical events within your organization, fostering streamlined communication and facilitating a more efficient workflow. This centralized approach enhances collaboration and ensures that all relevant parties are promptly informed of important updates and changes.

📘

Note

You can create up to five webhooks for your organization.

Example

Let's consider an example in the context of a fintech organization called XYZ Corp that utilizes organization-level webhooks to streamline notifications across the organization. In this example, you work as a team leader at XYZ Corp.

As the team leader at XYZ Corp, you understand the importance of centralized and efficient communication within your organization. With organization-level webhooks, you can ensure that all relevant stakeholders receive timely notifications when specific events occur.
Imagine that a Book called Monthly Transaction Analysis needs to be verified within your organization. Regardless of the number of API accounts present in XYZ Corp, the organization-level webhook will trigger and send the relevant payload to the configured webhook URL(s).

By implementing organization-level webhooks, XYZ Corp establishes a centralized and consolidated notification system for important events. Instead of configuring individual URLs for each account, a single URL is set up to handle notifications across all accounts within the organization. This approach ensures efficiency and eliminates redundant notifications.

As the team leader, you can effectively monitor and respond to critical events within your organization using organization-level webhooks. For example, when the Monthly Transaction Analysis Book is successfully verified, you and other relevant stakeholders will receive immediate notifications through the centralized webhook. This enables prompt decision-making, collaboration, and efficient workflow management.

Benefits

To establish the organization-wide webhooks that are applicable to all accounts, we suggest utilizing organization-level webhooks. This approach enables the configuration of a single webhook that will be activated for events occurring throughout the entire organization, ensuring a centralized and standardized notification system.

Alternatively, if you require the flexibility to set up distinct webhooks for specific event sets within your organization, organization-level webhooks remain the recommended option. By configuring multiple webhooks with unique event subscriptions, you can customize the notifications according to the specific requirements of different teams or accounts within your organization. This allows for a more tailored and targeted approach to notification management.

We support adding multiple webhooks for an organization which can be added with the add webhook endpoint. To know more, see Add Webhook.

Available events

The organization-level webhook supports the following events:

1. book.analytics_v2.generated: This event indicates that the analytics data for a Book is produced using the v2 analytics engine. Verified Docs include only those documents that are in the VERIFICATION_COMPLETE state.

   • Click to expand or collapse the JSON code example of this event

     JSON example

     {
       "severity": "HIGH",
       "notification_type": "STATUS",
       "notification_reason": "Analytics V2 generated for the book",
       "event_name": "book.analytics_v2.generated",
       "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117",
       "verified_docs": [
         "c5d3a53b-2840-4e9c-8d84-d804e3b17bab"
       ]
     }
     

2. book.classified: This event indicates that a book has been classified or categorized.

   • Click to expand or collapse the JSON code example of this event

     JSON example

     {  
       "notification_type": "STATUS",  
       "notification_reason": "Book is classified",  
       "mixed_uploaded_docs": [  
         {  
           "status": "COMPLETED",  
           "mixed_uploaded_doc_uuid": "db7fe37f-3fc8-4a0a-9066-94101a174832"  
         }  
       ],  
       "severity": "MODERATE",  
       "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117",  
       "event_name": "book.classified"  
     }
     

3. book.completed: This event is triggered when the Capture, Detect, and Analytics processes are completed for a Book. Capture is mandatory for this event to be triggered, while Analytics and Detect are required only if they are enabled for your organization.

   • Click to expand or collapse the JSON code example of this event

     JSON example

     {
         "tasks": [
             "DETECT",
             "ANALYTICS",
             "CAPTURE"
         ],
         "notification_reason": "Book is Completed",
         "book_uuid": "0742a2a7-8046-4c6f-a23e-ba259ef8e14f",
         "uploaded_docs": [
             {
                 "status": "VERIFICATION_COMPLETE",
                 "uuid": "6e2151c0-70ee-4454-a09d-585a3277954b"
             }
         ],
         "event_name": "book.completed",
         "notification_type": "STATUS",
         "severity": "HIGH",
         "book_context_class": "INSTANT"
     }
     

     📘

     Note

     The turnaround time (TAT) for this event is the slowest of all the three processes i.e., Capture, Detect, and Analytics.

4. book.detect.signal_found: Indicates that the uploaded Book contains at least one document that contains signals of suspicious activity.

   • Click to expand or collapse the JSON code example of this event

     JSON example

     {
       "notification_type": "STATUS",
       "notification_reason": "Detect signals found in the book",
       "uploaded_docs": [
           {
               "uploaded_doc_uuid": "db7fe37f-3fc8-4a0a-9066-94101a174832",
               "uploaded_doc_detect_status": "COMPLETED",
               "signal_count": 1,
           },
           {
               "uploaded_doc_uuid": "db7fe37f-3fc8-4a0a-9066-94101a174832",
               "uploaded_doc_detect_status": "UNSUPPORTED",
               "signal_count": 0,
               "reason": "Detect could not find any forms in the document to run on."
           }
       ],
       "severity": "MODERATE",
       "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117",
       "event_name": "book.detect.signal_found"
     }
     

5. book.detect.signal_not_found: Indicates that the uploaded Book does not contain any documents with signals of suspicious activity.

   • Click to expand or collapse the JSON code example of this event

     JSON example

     {
       "notification_type": "STATUS",
       "notification_reason": "Detect signals not found in the book",
       "uploaded_docs": [
           {
               "uploaded_doc_uuid": "db7fe37f-3fc8-4a0a-9066-94101a174832",
               "uploaded_doc_detect_status": "COMPLETED",
               "signal_count": 0,
           }
       ],
       "severity": "MODERATE",
       "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117",
       "event_name": "book.detect.signal_not_found"
     }
     

6. book.verified: Indicates that the Capture process has been completed, and all documents within a Book have either been verified or rejected.

   • Click to expand or collapse the JSON code example of this event

     JSON example

     {
        "status":"BOOK_COMPLETE",
        "book_uuid":"4920621f-503f-4662-8df8-5e7cb585d147",
        "severity":"MODERATE",
        "event_name":"book.verified",
        "book_pk":45976574,
        "notification_reason":"Book is verified",
        "notification_type":"STATUS",
        "uploaded_docs":[
           {
              "status":"VERIFICATION_COMPLETE",
              "uuid":"97e7fff6-5d50-46ea-82d6-99cee9d605a5"
           }
        ]
     }
     

7. document.classification_failed: This event indicates that the classification process for a document has failed.

   • Click to expand or collapse the JSON code example of this event

     JSON example

     {
       "event_name": "document.classification_failed",
       "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117",
       "notification_type": "ISSUE",
       "severity": "MODERATE",
       "notification_reason": "File is corrupt",
       "uploaded_image_group_uuid": "c44b1d25-fdbe-488c-b0af-ae062286a67d",
       "mixed_uploaded_doc_uuid": "3ea1bdd6-51e0-4ac5-bee3-e09ca1b683d6"
     }
     

8. document.classification_succeeded: This event indicates that the classification process for a document has succeeded.

   • Click to expand or collapse the JSON code example of this event

     JSON example

     {  
       "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117",  
       "severity": "MODERATE",  
       "notification_reason": "Document is classified",  
       "event_name": "document.classification_succeeded",  
       "mixed_uploaded_doc_uuid": "3ea1bdd6-51e0-4ac5-bee3-e09ca1b683d6",  
       "uploaded_image_group_uuid": "c44b1d25-fdbe-488c-b0af-ae062286a67d",  
       "notification_type": "STATUS"  
     }
     

9. document.detect.signal_found: Indicates that the uploaded document contains signals of suspicious activity.

   • Click to expand or collapse the JSON code example of this event

     JSON example

     {  
         "book_name": "Test Book",  
         "book_pk": 5985,  
         "book_uuid": "1e03d9cd-7d84-4672-bc3d-c19cd19c500b",  
         "doc_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3",  
         "event_name": "document.detect.signal_found",  
         "is_cloud_compliant": false,  
         "mixed_uploaded_doc_pk": 2771,  
         "mixed_uploaded_doc_uuid": "28d93a46-fe87-4fab-bfdb-ac4594046956",  
         "notification_reason": "Detect signals found in document",  
         "notification_type": "STATUS",  
         "severity": "MODERATE",  
         "status": "VERIFICATION_COMPLETE",  
         "uploaded_doc_name": "Test Doc",  
         "uploaded_doc_pk": 2961,  
         "uploaded_doc_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3",  
         "uploaded_image_group_pk": 8486,  
         "uploaded_image_group_uuid": "8d2aa083-800e-4442-9dbd-a683a3f4f9d8"  
     }
     

     📘

     Note

     The uploaded_doc_uuid and doc_uuid attributes are the same. These are being maintained for backward compatibility.

10. document.detect.signal_not_found: Indicates that the uploaded document does not contain signals of suspicious activity.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
          "book_name": "Test Book",
          "book_pk": 5985,
          "book_uuid": "1e03d9cd-7d84-4672-bc3d-c19cd19c500b",
          "doc_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3",
          "event_name": "document.detect.signal_not_found",
          "is_cloud_compliant": false,
          "mixed_uploaded_doc_pk": 2771,
          "mixed_uploaded_doc_uuid": "28d93a46-fe87-4fab-bfdb-ac4594046956",
          "notification_reason": "No detect signals found in document",
          "notification_type": "STATUS",
          "severity": "MODERATE",
          "status": "VERIFICATION_COMPLETE",
          "uploaded_doc_name": "Test Doc",
          "uploaded_doc_pk": 2961,
          "uploaded_doc_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3",
          "uploaded_image_group_pk": 8486,
          "uploaded_image_group_uuid": "8d2aa083-800e-4442-9dbd-a683a3f4f9d8"
      }
      

      📘

      Note

      The uploaded_doc_uuid and doc_uuid attributes are the same. These are being maintained for backward compatibility.

11. document.detect.unable_to_process: Indicates that the uploaded document could not be processed through Detect. The specific reason for this will be provided in the webhook.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
          "book_name": "Test Book",
          "book_pk": 5985,
          "book_uuid": "1e03d9cd-7d84-4672-bc3d-c19cd19c500b",
          "doc_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3",
          "event_name": "document.detect.unable_to_process",
          "is_cloud_compliant": false,
          "mixed_uploaded_doc_pk": 2771,
          "mixed_uploaded_doc_uuid": "28d93a46-fe87-4fab-bfdb-ac4594046956",
          "notification_reason": "Detect couldn't process the document. Reason: Currently, Detect does not support image based PDFs",
          "notification_type": "STATUS",
          "severity": "MODERATE",
          "status": "VERIFICATION_COMPLETE",
          "uploaded_doc_name": "Test Doc",
          "uploaded_doc_pk": 2961,
          "uploaded_doc_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3",
          "uploaded_image_group_pk": 8486,
          "uploaded_image_group_uuid": "8d2aa083-800e-4442-9dbd-a683a3f4f9d8"
      }
      

      📘

      Note

      The uploaded_doc_uuid and doc_uuid attributes are the same. These are being maintained for backward compatibility.

12. document.upload_failed: This event indicates that the upload of a document has failed.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
        "severity": "MODERATE",
        "notification_reason": "File is corrupt",
        "notification_type": "ISSUE",
        "event_name": "document.upload_failed",
        "file_name": "test_file.pdf",
        "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117"
      }
      

13. document.upload_succeeded: This event indicates that the upload of a document has succeeded.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
        "notification_type": "STATUS",
        "notification_reason": "Document uploaded",
        "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117",
        "event_name": "document.upload_succeeded",
        "doc_uuid": "db7fe37f-3fc8-4a0a-9066-94101a174832",
        "severity": "LOW"
      }
      

14. document.verification_failed: Indicates that a single document within a book has failed. For more information about document statuses, see Document statuses.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
          "book_pk": 5985,
          "book_uuid": "1e03d9cd-7d84-4672-bc3d-c19cd19c500b",
          "doc_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3",
          "event_name": "document.verification_failed",
          "mixed_uploaded_doc_pk": 2771,
          "mixed_uploaded_doc_uuid": null,
          "notification_reason": "File is corrupt",
          "notification_type": "ISSUE",
          "severity": "MODERATE",
          "status": "REJECTED",
          "uploaded_doc_pk": 2961,
          "uploaded_doc_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3",
          "uploaded_image_group_pk": 8486,
          "uploaded_image_group_uuid": null
      }
      

      📘

      Note

      The uploaded_doc_uuid and doc_uuid attributes are the same. These are being maintained for backward compatibility.

15. document.verification_succeeded: Indicates that a single document within a book has succeeded.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
          "book_pk": 5985,
          "book_uuid": "1e03d9cd-7d84-4672-bc3d-c19cd19c500b",
          "doc_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3",
          "event_name": "document.verification_succeeded",
          "mixed_uploaded_doc_pk": 2771,
          "mixed_uploaded_doc_uuid": null,
          "notification_reason": "Document verified",
          "notification_type": "STATUS",
          "severity": "LOW",
          "status": "VERIFICATION_COMPLETE",
          "uploaded_doc_pk": 2961,
          "uploaded_doc_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3",
          "uploaded_image_group_pk": 8486,
          "uploaded_image_group_uuid": null
      }
      

      📘

      Note

      The uploaded_doc_uuid and doc_uuid attributes are the same. These are being maintained for backward compatibility.

16. image_group.upload_failed: This event indicates that the upload of an image group has failed.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
        "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117",
        "event_name": "image_group.upload_failed",
        "notification_reason": "File is corrupt",
        "image_group_uuid": "db7fe37f-3fc8-4a0a-9066-94101a174832",
        "notification_type": "ISSUE",
        "severity": "MODERATE"
      }
      

17. image_group.upload_succeeded: This event indicates that the upload of an image group has succeeded.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
        "event_name": "image_group.upload_succeeded",
        "severity": "MODERATE",
        "notification_reason": "Image group is uploaded",
        "notification_type": "STATUS",
        "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117",
        "image_group_uuid": "db7fe37f-3fc8-4a0a-9066-94101a174832"
      }
      

18. image_group.verification_failed: This event is triggered when the image group verification fails. To learn more about image grouping, see Image group.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
          "book_pk": 5985,
          "book_uuid": "1e03d9cd-7d84-4672-bc3d-c19cd19c500b",
          "event_name": "image_group.verification_failed",
          "image_group_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3",
          "notification_reason": "File is corrupt",
          "notification_type": "ISSUE",
          "severity": "MODERATE",
          "status": "REJECTED",
          "uploaded_image_group_pk": 8486,
          "uploaded_image_group_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3"
      }
      

      📘

      Note

      The uploaded_image_group_uuid and image_group_uuid attributes are the same. These are being maintained for backward compatibility.

19. image_group.verification_succeeded: This event is triggered when the image group verification succeeds.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
        "status": "VERIFICATION_COMPLETED",
        "severity": "LOW",
        "uploaded_image_group_pk": 8486,
        "book_uuid": "1e03d9cd-7d84-4672-bc3d-c19cd19c500b",
        "uploaded_image_group_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3",
        "notification_reason": "Image Group verified",
        "event_name": "image_group.verification_succeeded",
        "book_pk": 5985,
        "notification_type": "STATUS",
        "image_group_uuid": "61d93bbd-8412-4b0b-9e98-693d0b1236d3"
      }
      

      📘

      Note

      The uploaded_image_group_uuid and image_group_uuid attributes are the same. These are being maintained for backward compatibility.

20. plaid.upload_failed: This event indicates that the upload of Plaid data has failed.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
        "notification_type": "ISSUE",
        "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117",
        "file_name": "test_file.json",
        "notification_reason": "File is corrupt",
        "event_name": "plaid.upload_failed",
        "severity": "MODERATE"
      }
      

21. plaid.upload_succeeded: This event indicates that the upload of Plaid data has succeeded.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
        "notification_reason": "Json uploaded",
        "severity": "LOW",
        "notification_type": "STATUS",
        "doc_uuid": "db7fe37f-3fc8-4a0a-9066-94101a174832",
        "event_name": "plaid.upload_succeeded",
        "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117"
      }
      

22. network.book.created (BETA): Indicates that another Network customer submitted an application for a borrower you are currently monitoring (SMB only).

    • Click to expand or collapse the JSON code example of this event

      1. • 
           

      JSON example

      {
        "notification_type": "STATUS",
        "notification_reason": "A new application has been submitted for a borrower you are currently monitoring",
        "severity": "HIGH",
        "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117",
        "event_name": "network.book.created"
      }
      

23. network.book.funded (BETA): Indicates that another Network customer funded a borrower you are currently reviewing or monitoring (SMB only).

    • Click to expand or collapse the JSON code example of this event

      1. • 
           

      JSON example

      {
        "severity": "HIGH",
        "notification_type": "STATUS",
        "notification_reason": "A borrower you are currently reviewing or monitoring has been funded",
        "event_name": "network.book.funded",
        "book_uuid": "8ef7a1e1-fc97-42f9-81ea-ef357b333117"
      }
      

24. book.analytics_completed: Indicates the completion of an asynchronous analytics request, making the results accessible. To learn more about this, see Async analytics request.

    • Click to expand or collapse the JSON code example of this event

      JSON example

      {
        "notification_reason": "Analytics Generated successfully",
        "severity": "MODERATE",
        "notification_type": "STATUS",
        "event_name": "book.analytics_completed",
        "analytics_request_id": "4ea682b4-b23d-48da-b954-728ef7047f92",
        "status": "COMPLETED",
        "event": "ANALYTICS_COMPLETED",
        "book_uuid": "1e03d9cd-7d84-4672-bc3d-c19cd19c500b",
        "book_pk": 5985
      }
      

      📘

      Note

      This event is only for our Legacy Analytics offering.