Webhooks

Umbra ERP uses webhooks to notify your server of events in real time. When a resource changes (e.g., invoice paid, lead created, employee added), Umbra ERP sends an HTTP POST request to your configured webhook URL.

POST/v1/webhooks

Create webhook

Required attributes

Name
url
Type
string
Description
The HTTPS URL where Umbra ERP will send event notifications.
Name
events
Type
array
Description
List of event types to subscribe to (e.g., ["invoice.paid", "lead.created", "employee.added"]).

Request

POST

/v1/webhooks

curl -X POST https://api.umbraerp.com/v1/webhooks \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://yoursite.com/webhooks/umbra",
    "events": ["invoice.paid", "lead.created"]
  }'

Response

{
  "result": "success",
  "message": "Webhook created successfully."
}

GET/v1/webhooks

List webhooks

Retrieve all registered webhook URLs for your account.

Request

GET

/v1/webhooks

curl https://api.umbraerp.com/v1/webhooks \
  -H "Authorization: Bearer <your_access_token>"

Response

{
  "result": "success",
  "webhooks": [
    {
      "id": 1,
      "url": "https://yoursite.com/webhooks/umbra",
      "events": ["invoice.paid", "lead.created"],
      "is_active": true,
      "dateCreated": "2026-01-15T10:30:00Z"
    }
  ]
}

GET/v1/webhooks/:id

Fetch webhook

Retrieve details of a specific webhook by its ID.

Request

GET

/v1/webhooks/1

curl https://api.umbraerp.com/v1/webhooks/1 \
  -H "Authorization: Bearer <your_access_token>"

PUT/v1/webhooks/:id

Update webhook

Update an existing webhook URL or its subscribed events.

Optional attributes

Name
url
Type
string
Description
New HTTPS webhook URL.
Name
events
Type
array
Description
Updated list of event types.
Name
is_active
Type
boolean
Description
Enable or disable the webhook.

Request

PUT

/v1/webhooks/1

curl -X PUT https://api.umbraerp.com/v1/webhooks/1 \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://yoursite.com/webhooks/umbra-v2",
    "is_active": true
  }'

Response

{
  "result": "success",
  "message": "Webhook updated successfully."
}

DELETE/v1/webhooks/:id

Delete webhook

Remove a webhook URL from your account.

Request

DELETE

/v1/webhooks/1

curl -X DELETE https://api.umbraerp.com/v1/webhooks/1 \
  -H "Authorization: Bearer <your_access_token>"

Response

{
  "result": "success",
  "message": "Webhook deleted successfully."
}