API (Webhooks) Documentation
Welcome to the WellyBox Webhooks feature documentation!
With WellyBox Webhooks, you can easily stay updated on the status changes of your documents. Whenever the status of a document changes within the WellyBox system, an HTTP POST request will be sent to a specified URL in JSON format.
This allows you to seamlessly integrate WellyBox with your own systems or applications, keeping you informed about the progress of your documents.
To start using WellyBox Webhooks, follow these steps:
Navigate to https://app.wellybox.com/ng2ux/webhooks to access the Webhooks settings within your WellyBox account.
Click on the "Connect New Webhook" button to initiate the webhook creation process.
Name: Provide a descriptive name for your webhook.
URL: Specify the URL where you want to receive the webhook POST requests.
WellyBox supports the following document statuses:
Pending: Document introduced to the system.
Ready: Document reviewed by the user.
Sent: Document exported.
The webhook will trigger an HTTP POST request whenever a document's status changes to one of the specified statuses.
When the webhook is triggered, you'll receive a JSON payload containing information about the document. Below is an example JSON payload:
{
"Received Date": "2023-Jul-30",
"Document Date": "2023-Jul-30",
"Vendor": "ABC Company",
"Total Amount": "1150.0",
"Total Tax": "",
"Currency": "USD",
"Expense Category": "General and Administrative",
"Business": "Business",
"Document Type": "invoice",
"Path in ZIP": "Business/2025_02/abc_corp_23022025.pdf",
"allocation_number": "",
"Doc Number": "12345",
"Source": "test@wellybox.com",
"Has Star": "No",
"Link": "https://app.wellybox.com/c/l8u7dJy1IV6Moeu6",
"Comment": "",
"status": "pending",
"client_email": "client1@wellybox.com",
"source_sender": "Dan Bar <danbar@wellybox.com>",
"content": "Special offer: Until August 15, 2023. All rights reserved by ABC Company.",
"doc_uuid": "55171a92-e62d-428d-a0aa-9e5a9c9c7786",
"source_foreign_id": null,
"source_thread_id": null
}
```
You will receive this JSON payload as an HTTP POST request to the specified URL whenever a document's status changes.
The type and description of the fields of the JSON
Received Date
string
The date when the document was received. Format: YYYY-MMM-DD (e.g., "2023-Jul-30").
Document Date
string
The date mentioned in the document (invoice, receipt, etc.). Format: YYYY-MMM-DD.
Vendor
string
Name of the vendor who issued the document.
Total Amount
string
The total amount charged in the document.
Total Tax
string
The tax amount specified in the document. Can be empty if tax is not applicable.
Currency
string
Currency code in which the transaction occurred (e.g., "USD").
Expense Category
string
The classification of the expense (e.g., "General and Administrative").
Business
string
Indicates whether the document is related to a business expense. Common values: "Business", "Personal".
Document Type
string
The type of document, such as "invoice", "receipt", etc.
Path in ZIP
string
The file path of the document inside the exported ZIP archive.
allocation_number
string
A reference number for allocation. For Israeli transactions with a value greater than 25,000, an allocation number is required. In other cases, this field may be left empty.
Doc Number
string
The identifier of the document, typically assigned by the vendor.
Source
string
The email address from which the document was extracted.
Has Star
string
Indicates if the document is marked as important. "Yes" or "No".
Link
string
A URL to access the PDF document in WellyBox.
Comment
string
Any additional user comments related to the document. May be empty.
status
string
The processing status of the document. Common values: "pending", "ready".
client_email
string
The email address associated with the WellyBox account.
source_sender
string
The name and email of the sender who provided the document. Format: "Name <email>".
content
string
Extracted text content from the document.
doc_uuid
string
A unique identifier (UUID) for the document in WellyBox.
source_foreign_id
null or string
An optional foreign identifier from the source system.
source_thread_id
null or string
The email thread ID from which the document originated.
Once you have configured your webhook settings, you can also perform a test by manually changing the status of a document to see if the webhook triggers correctly.
That's it!
You are now set up to receive real-time updates about the status changes of your documents through WellyBox Webhooks.
This integration will help you streamline your document management process and keep your systems in sync with WellyBox. If you have any questions or need further assistance, feel free to reach out to our support team.
With WellyBox Webhooks, you can easily stay updated on the status changes of your documents. Whenever the status of a document changes within the WellyBox system, an HTTP POST request will be sent to a specified URL in JSON format.
This allows you to seamlessly integrate WellyBox with your own systems or applications, keeping you informed about the progress of your documents.
Getting Started
To start using WellyBox Webhooks, follow these steps:
1. Access Webhooks Settings
Navigate to https://app.wellybox.com/ng2ux/webhooks to access the Webhooks settings within your WellyBox account.
2. Create a New Webhook
Click on the "Connect New Webhook" button to initiate the webhook creation process.
3. Configure Webhook
Name: Provide a descriptive name for your webhook.
URL: Specify the URL where you want to receive the webhook POST requests.
Document Statuses
WellyBox supports the following document statuses:
Pending: Document introduced to the system.
Ready: Document reviewed by the user.
Sent: Document exported.
The webhook will trigger an HTTP POST request whenever a document's status changes to one of the specified statuses.
JSON Payload
When the webhook is triggered, you'll receive a JSON payload containing information about the document. Below is an example JSON payload:
{
"Received Date": "2023-Jul-30",
"Document Date": "2023-Jul-30",
"Vendor": "ABC Company",
"Total Amount": "1150.0",
"Total Tax": "",
"Currency": "USD",
"Expense Category": "General and Administrative",
"Business": "Business",
"Document Type": "invoice",
"Path in ZIP": "Business/2025_02/abc_corp_23022025.pdf",
"allocation_number": "",
"Doc Number": "12345",
"Source": "test@wellybox.com",
"Has Star": "No",
"Link": "https://app.wellybox.com/c/l8u7dJy1IV6Moeu6",
"Comment": "",
"status": "pending",
"client_email": "client1@wellybox.com",
"source_sender": "Dan Bar <danbar@wellybox.com>",
"content": "Special offer: Until August 15, 2023. All rights reserved by ABC Company.",
"doc_uuid": "55171a92-e62d-428d-a0aa-9e5a9c9c7786",
"source_foreign_id": null,
"source_thread_id": null
}
```
You will receive this JSON payload as an HTTP POST request to the specified URL whenever a document's status changes.
JSON Field Documentation
The type and description of the fields of the JSON
Received Date
string
The date when the document was received. Format: YYYY-MMM-DD (e.g., "2023-Jul-30").
Document Date
string
The date mentioned in the document (invoice, receipt, etc.). Format: YYYY-MMM-DD.
Vendor
string
Name of the vendor who issued the document.
Total Amount
string
The total amount charged in the document.
Total Tax
string
The tax amount specified in the document. Can be empty if tax is not applicable.
Currency
string
Currency code in which the transaction occurred (e.g., "USD").
Expense Category
string
The classification of the expense (e.g., "General and Administrative").
Business
string
Indicates whether the document is related to a business expense. Common values: "Business", "Personal".
Document Type
string
The type of document, such as "invoice", "receipt", etc.
Path in ZIP
string
The file path of the document inside the exported ZIP archive.
allocation_number
string
A reference number for allocation. For Israeli transactions with a value greater than 25,000, an allocation number is required. In other cases, this field may be left empty.
Doc Number
string
The identifier of the document, typically assigned by the vendor.
Source
string
The email address from which the document was extracted.
Has Star
string
Indicates if the document is marked as important. "Yes" or "No".
Link
string
A URL to access the PDF document in WellyBox.
Comment
string
Any additional user comments related to the document. May be empty.
status
string
The processing status of the document. Common values: "pending", "ready".
client_email
string
The email address associated with the WellyBox account.
source_sender
string
The name and email of the sender who provided the document. Format: "Name <email>".
content
string
Extracted text content from the document.
doc_uuid
string
A unique identifier (UUID) for the document in WellyBox.
source_foreign_id
null or string
An optional foreign identifier from the source system.
source_thread_id
null or string
The email thread ID from which the document originated.
Test
Once you have configured your webhook settings, you can also perform a test by manually changing the status of a document to see if the webhook triggers correctly.
That's it!
You are now set up to receive real-time updates about the status changes of your documents through WellyBox Webhooks.
This integration will help you streamline your document management process and keep your systems in sync with WellyBox. If you have any questions or need further assistance, feel free to reach out to our support team.
Updated on: 16/02/2025
Thank you!