Skip to main content
GET
/
api
/
sys
/
webhooks
/
{id}
{
  "BusinessId": 123,
  "Name": "<string>",
  "Action": 123,
  "Description": "<string>",
  "URL": "<string>",
  "Active": true,
  "LastError": "<string>",
  "ErrorCount": 123,
  "LastTrigger": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the WebHook-Read role.

​
Path Parameters

​
id
integer
required
The Id of the WebHook record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/webhooks/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
BusinessId
integer
Business Id.
​
Name
string
Name.
​
Action
integer
Action.
​
Description
string
Description.
​
URL
string
URL.
​
Active
boolean
Active.
​
LastError
string
Last Error.
​
ErrorCount
integer
Error Count.
​
LastTrigger
string
Last Trigger.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "BusinessId": 0,
  "Name": "",
  "Action": 0,
  "Description": null,
  "URL": "",
  "Active": false,
  "LastError": null,
  "ErrorCount": 0,
  "LastTrigger": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "WebHook Example",
  "LocalizationDetails": null,
  "CustomFields": null
}