Edara API
Edara API
  • Edara API Walk Through
  • Edara Webhooks
  • Accounting
    • Returns a list of Taxs
      GET
    • Returns a list of Accounts
      GET
    • Returns a list of NP Report
      GET
    • Returns a list of NR Report
      GET
    • Return a Tax by ID
      GET
    • Returns a list of Cost Centers
      GET
    • Returns an Account by Id
      GET
    • Return a Currency by ID
      GET
    • Delete an existing Currency
      DELETE
    • Return a Tax by Name
      GET
    • Return a Taxes by Rate
      GET
    • Return a Taxes by Scope
      GET
    • Returns an Cost Center by Id
      GET
    • Return a E-Invoice tax codes by country
      GET
    • Returns a list of Accounts by Account Type
      GET
    • Return a Currency by Code
      GET
    • Returns a list of Account Nodes
      GET
    • Returns a list of Currencies
      GET
    • Update an existing Currency
      PUT
    • Create a new Currency
      POST
    • Return account by description
      GET
    • Return a Journal Entry by Code
      GET
    • Returns an Account
      GET
    • Returns an Account
      GET
    • Returns an Account by ClassificationCode
      GET
    • Returns an Account
      GET
    • Returns Account Balance
      GET
    • UpdateTax
      PUT
    • Create a new Tax
      POST
    • Update an existing Currency
      PUT
    • Update a Journal Entry By Code
      PUT
    • Return a Journal Entry by Code
      POST
    • Create a Cash Out
      POST
    • Create a Journal Entry
      POST
    • Pay Sales Order By Journal Entry
      POST
    • Create a Taxable Sales Invoice
      POST
    • Delete an existing Tax
      DELETE
    • Delete an existing Currency
      DELETE
    • Delete a Journal Entry by Code
      DELETE
  • Common
    • Returns a list of Cities
    • Update an existing City
    • Create a new City
    • Returns a list of Countries
    • Update an existing Country
    • Create a new Country
    • Returns a list of Districts
    • Update an existing District
    • Create a new District
    • Return a City by ID
    • Delete an existing City
    • Return a Country by ID
    • Delete an existing Country
    • Return a District by ID
    • Delete an existing District
    • Find a City by Name
    • Returns a list of Districts by City Id
    • Returns a list of Cities by Country Id
    • Find a Country by Name
    • Find a District by Name
    • Return a Classification by ID
    • Return a Setting by Module and Key
    • Find a Classification by Name
    • Returns a list of Setting
    • Convert money from numeric value to Arabic words
    • Convert money from numeric value to English words
    • Ping
    • Notifications
  • Purchase
    • find supplier by Id
    • Delete supplier
    • Return a PurchaseOrder by ID
    • find supplier by name
    • Returns a list of Suppliers
    • update supplier
    • create supplier
    • Returns a list of PurchaseOrder
    • Return a PurchaseOrder by Code
  • Sales
    • Return a Customer by ID
    • Delete an existing Customer
    • Return a Bundle by ID
    • Delete an existing Bundle
    • Returns a list of Sales Order Print Templates
    • Return a SalesOrder by ID
    • Delete an existing SalesOrder
    • Return a SalesPerson by ID
    • Delete an existing SalesPerson
    • Return a ServiceItem by ID
    • Delete an existing ServiceItem
    • Return a Customer Addresses by Customer ID
    • Return a Customer by Code
    • Return a Customer by Name
    • Return a Customer by Email
    • Find a Customer
    • Return a Customer by ExternalId
    • Return a Customer by Mobile
    • Returns a list of Customers
    • Update an existing Customer
    • Create a new Customer
    • Return a SalesOrder by Code
    • Return a Sales Order Print Template by ID
    • GetCustomerBalance
    • Return a SalesPerson by Code
    • Return a SalesPerson by Name
    • Return a ServiceItem by Code
    • Return a ServiceItem by Name
    • Return a SalesPerson by ExternalId
    • Returns a list of SalesPersons
    • Update an existing SalesPerson
    • Create a new SalesPerson
    • Return a ServiceItem by ExternalId
    • Returns a list of ServiceItems
    • Update an existing ServiceItem
    • Create a new ServiceItem
    • Return Customers by ExternalIds
    • Returns a list of SalesOrder
    • Update an existing SalesOrder
    • Create a new SalesOrder
    • Returns a list of SalesStores
    • Create a new SalesStore
    • Returns a list of Bundles
    • Create a new Bundle
    • Return a list of sales documents by specific criteria
    • Update existing Customers
    • Update the Header an existing SalesOrder
    • Update existing Customers
    • Update existing Customers
    • Deactivate an existing Customer
    • Update an existing Customer
    • Cancel SalesOrder
    • Cancel SalesOrder
    • Update an existing SalesOrder
    • UnIssue SalesOrder
    • Deactivate an existing Customer
    • Update an existing SalesPerson
    • Update an existing ServiceItem
    • Update SalesOrder Status
    • Create a new SalesReturn
    • Create sales order and related IO/SI and return created SO code
    • Create cash-in for specified SO and update it with discount value and return created cash-in code
    • Create new Customers
    • Returns a list of SalesOrder Header
    • Delete an existing Customer
    • Delete an existing SalesPerson
    • Delete an existing ServiceItem
  • Warehouse
    • Return a Brand by ID
    • Returns a list of standard units of measure
    • Returns a list of StockItems Tree by User ID
    • Return a StockItem by ID
    • Deactivate an existing StockItem
    • Delete an existing StockItem
    • Return a Warehouse by ID
    • Delete an existing warehouse
    • Return a WorkOrder by ID
    • Return a StockItem by SKU
    • Returns a list of StockItem Classifications
    • Create a new stockitem classification
    • Return StockItems by IDs
    • Return a StockItem balance by ID
    • Return a Warehouse balance by Warehouse ID
    • Return a Brand by Name
    • Returns a list of Warehouse Tree by User ID
    • GetStockItemGlobalBalanceBySKU
    • Returns a list of Brands
    • Create a new Brand
    • Return StockItems by Codes
    • Return a StockItem by Code
    • GetStockItemGlobalBalanceByCode
    • Return a Warehouse by Code
    • Return a Warehouse by Name
    • Return a WorkOrder by Code
    • Return stock item global balance object by id
    • Return a StockItem by Code or SKU
    • Returns a list of StockItems
    • Update an existing StockItem
    • Create a new StockItem
    • Returns a list of Warehouses
    • Update an existing Warehouse
    • Create a new Warehouse
    • Returns a list of DynamicProperty Tree by User ID
    • Get stock item cost (by id) on specific date
    • Search for StockItems
    • Returns a list of RMA Warehouses
    • Get bulk stock items cost (by SKUs) on specific date
    • Return a StockItem balance for a specific Warehouse
    • Return a StockItem by Part Number
    • Return a StockItem by Code
    • Return StockItems by External IDs
    • Return StockItems by Part Numbers
    • Get bulk stock items cost (by part numbers) on specific date
    • Validate Item Serial is Returned
    • Validate Item Serial for Returns
    • Return a all StockItems balances
    • Get stockitems balance by warehous
    • Update existing StockItems
    • Update existing StockItems
    • Update Stock Item External Id
    • Update existing StockItems
    • Update Supplies Request
    • Update an existing StockItem
    • Update an existing Warehouse
    • Deactivate an existing StockItem
    • Update an existing issue offering
    • Update an existing receive supplies
    • Create a new Unit Of Measure
    • Create StockItems
    • Create a new issue offering
    • Create a new receive supplies
    • Delete an existing StockItem
    • Delete an existing warehouse
    • Delete an issue offering by code
    • Delete an issue offering by code

Edara Webhooks

What is a Webhook in Edara ERP?#

A webhook in Edara ERP is a way for the system to send real-time notifications to an external service when certain events occur. Instead of continuously polling the API for updates, webhooks allow Edara ERP to instantly notify external systems by sending an HTTP request to a specified URL whenever an event (such as adding a new stock item) takes place.
Webhooks are especially useful for integrating Edara ERP with other systems or applications, automating workflows, and ensuring timely data updates.

How to Create a Webhook#

To set up a webhook in Edara ERP, follow these steps:
1.
Access your Edara account.
2.
Navigate to Data > Integration > Webhooks.
3.
Click Add New Webhook.
4.
Fill in the necessary details:
Name: Give your webhook a name for easy identification.
URL: The external URL where the webhook data will be sent. This is the "listening" URL on your system.
Token: (Optional) If needed, include a token for authentication or security purposes.
5.
Select the events for which the webhook should trigger. You can filter the events based on your needs.
Webhooks1.png
6.
After selecting the required events, configure any additional filters to fine-tune which events should trigger the webhook.
Webhooks2.png
7.
Save the webhook.

Example Webhook Body#

Here is a smaller example of the webhook payload sent when a stock item is added to Edara ERP:
{
  "entity_id": 97954,
  "entity_code": "",
  "entity_type": "StockItem",
  "event_type": "After_Add",
  "tenant_id": "7c584e91-e05a-4a10-856b-57100d451a9c",
  "tenant_name": "demo_k",
  "data": {
    "id": 97954,
    "description": "080120240238",
    "code": "",
    "sku": "080120240238",
    "price": 100.0,
    "dealer_price": 0.0,
    "fifo_cost": 0.0,
    "lifo_cost": 0.0,
    "average_cost": 0.0,
    "last_cost": 0.0,
    "part_number": "",
    "classification_id": 6411,
    "warranty": 12.0,
    "dynamic_properties_info": [
      {
        "dynamic_property_id": 5945,
        "dynamic_property": "Size",
        "dynamic_value_id": 5946,
        "dynamic_value": "S"
      },
      {
        "dynamic_property_id": 5945,
        "dynamic_property": "Size",
        "dynamic_value_id": 5947,
        "dynamic_value": "M"
      },
      {
        "dynamic_property_id": 5945,
        "dynamic_property": "Size",
        "dynamic_value_id": 5959,
        "dynamic_value": "L"
      }
    ],
    "is_grouping_item": false
  }
}
By setting up webhooks, Edara ERP will automatically send notifications about system events to your external system, allowing you to stay updated in real-time without polling the API.
Modified at 2024-09-24 11:05:38
Previous
Edara API Walk Through
Next
Returns a list of Taxs
Built with