EzzyBills Integration using Webhooks

Webhooks offer an efficient way to integrate your application with EzzyBills.

Why Use Webhooks?

• When integrating with EzzyBills API, you need a way to retrieve processed document data.
• Instead of manually tracking uploads or constantly polling EzzyBills for updates, you can set up a webhook task at the end of your workflow to handle notifications automatically.
• Once the workflow completes, EzzyBills will notify your system via the specified webhook URL.

Setting Up Webhooks

To configure a webhook:

• Go to “Workflows”, edit the workflow, and drag the task “Webhook” to the workflow, placing it as the last task. Save.

(Note: for a system workflow, you many need to duplicate it first, and edit the new copy).

[screenshot: add a webhook task to the workflow]

• Edit the settings for this task “Webhook” (screenshot above: double click the “Webhook” task)
• In this setting, enter the json text below to specify the WebhookUrl where EzzyBills should send notifications.

For example, your webhook task setting may look like this:

{
  "state": 302,
  "keywords": [
    {
      "name": "WebhookUrl",
      "value": "https://test.blah.com/1234"
    }
  ]
}

How Webhooks Work

For a document you have just uploaded, once the workflow completes, EzzyBills sends a notification to your webhook URL. The notification includes the DocID, which you can use with EzzyBills API (such as getInvoiceHeaderBlocks  ) to retrieve the processed data.

Benefits of Using Webhooks

• No Document Tracking: You don’t need to monitor or keep track of uploaded documents manually.
• No Polling Required: Webhooks eliminate the need to repeatedly poll EzzyBills to check the document processing status.
• Auto-Separation Handling: If a document splits into multiple documents because of auto-separation, EzzyBills will notify your webhook for each completed document individually.

Webhooks significantly reduce the complexity of your integration code, making it a streamlined and reliable approach for retrieving processed data. By leveraging this feature, you ensure your system is always up-to-date with the latest EzzyBills processing results.