Skip to main content
GET
/
api
/
sys
/
webhooks
Search WebHooks
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/webhooks \
  --header 'Authorization: Basic <encoded-value>'
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
A WebHook sends an HTTP POST request to a specified URL whenever a particular event occurs within a location. Webhooks let external systems react to changes in real time without polling the API. Each webhook is scoped to a single location (BusinessId) and is configured with an Action that identifies the triggering event (e.g. CoworkerCreate, BookingCreate, CoworkerInvoicePaid). Only one action can be assigned per webhook record — create separate webhook records if you need to react to multiple events. Nexudus will POST a JSON payload to the configured URL every time the selected action fires. If the endpoint returns a non-2xx response, the error is recorded in LastError and ErrorCount is incremented. A webhook is automatically disabled after repeated failures. Set Active to false to pause delivery without deleting the webhook. Use LastTrigger and LastError to monitor delivery health.

​
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-List role.

​
Enums

ValueName
1None
2CoworkerUpdate
3CoworkerCreate
4BlogPostCreate
5BlogPostUpdate
6BookingCreate
7BookingUpdate
8BookingDelete
9SendWelcomeEmail
10CoworkerContractActivate
11CoworkerContractCancel
12CoworkerContractRenew
13CoworkerContractUpgradeDowngrade
14CoworkerContractActivateFirst
15CoworkerInvoiceCreateFirst
16CoworkerInvoiceCreate
17CoworkerInvoiceDelete
18CoworkerInvoiceUpdate
19CoworkerInvoiceRefund
20CoworkerInvoiceCreditNote
21CoworkerInvoicePaid
22CoworkerInvoiceFailedPayment
23CoworkerInvoiceReceivedPayment
24CoworkerInvoiceAwaitingPayment
25CalendarEventCreate
26CalendarEventUpdate
27CalendarEventAttendeeDelete
28CalendarEventAttendeeCreate
29CalendarEventAttendeeUpdate
30GlobalChatMessageCreate
31NewsLetterSubscriberCreate
32NewsLetterSubscriberSubscribed
33NewsLetterSubscriberUnSubscribed
34NewsLetterSubscriberRemovedFromGroup
35CoworkerCheckout
36CoworkerCheckin
37CoworkerCheckinFailed
38VisitorNotification
39CommunityBoardNewThread
40CommunityBoardNewReply
41VisitorCheckedin
42VisitorRegistered
43BlogPostDelete
44CalendarEventDelete
45HelDeskMessageCreated
46HelpDeskCommentCreated
47CheckinCreated
48CheckinUpdated
49CheckinDeleted
50CoworkerDelete
51CoworkerMessageCreate
52DeliveryCreated
53DeliveryAssigned
54ProposalCreated
55ProposalUpdated
56ProposalDeleted
57TeamCreated
58TeamUpdated
59TeamDeleted
60CoworkerContractUpdate
61AccessControlUpdate
62CoworkerContractCreate
63FailedCheckin
64VisitorDeleted
65CoworkerInvoiceLedgerEntryCreate
66CoworkerInvoiceLedgerEntryDelete
67CoworkerInvoiceLedgerEntryUpdate
68CoworkerProductCreate
69CoworkerProductUpdate
70CoworkerProductDelete
71FloorPlanDeskCreate
72FloorPlanDeskDelete
73FloorPlanDeskUpdate
74TariffCreate
75TariffDelete
76TariffUpdate
77CoworkerContractDelete
78FloorPlanCreate
79FloorPlanDelete
80FloorPlanUpdate
81ProductCreate
82ProductDelete
83ProductUpdate
84BusinessUpdate
85CommunityGroupCreate
86CommunityGroupDelete
87CommunityGroupUpdate
88CoworkerPaymentMethodCreate
89CoworkerPaymentMethodDelete
90CoworkerPaymentMethodUpdate

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
WebHook_Business
integer
Filter by iD of the location this webhook belongs to.
​
WebHook_Name
string
Filter by display name for the webhook.
​
WebHook_Action
integer
Filter by the event that triggers this webhook (e.g. CoworkerCreate, BookingCreate, CoworkerInvoicePaid).
​
WebHook_Description
string
Filter by optional description of the webhook’s purpose.
​
WebHook_URL
string
Filter by the endpoint URL that receives the HTTP POST payload when the webhook fires.
​
WebHook_Active
boolean
Filter by whether the webhook is enabled and will fire when the configured action occurs.
​
WebHook_LastError
string
Filter by error message from the most recent failed delivery attempt.
​
WebHook_ErrorCount
integer
Filter by number of consecutive delivery failures since the last successful call.
​
WebHook_LastTrigger
string
Filter by date and time the webhook last fired successfully.

​
Range Filters

​
from_WebHook_ErrorCount
integer
Filter by number of consecutive delivery failures since the last successful call greater than or equal to this value.
​
to_WebHook_ErrorCount
integer
Filter by number of consecutive delivery failures since the last successful call less than or equal to this value.
​
from_WebHook_LastTrigger
string
Filter by date and time the webhook last fired successfully greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_WebHook_LastTrigger
string
Filter by date and time the webhook last fired successfully less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_WebHook_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_WebHook_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_WebHook_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_WebHook_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

​
Code Examples

​
Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/webhooks?page=1&size=15&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/sys/webhooks?WebHook_Name=example-value&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/webhooks?from_WebHook_UpdatedOn=2025-01-01T00:00&to_WebHook_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
WebHook[]
The list of WebHook records matching the query. See the Get one WebHook endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each WebHook. The following fields are not populated in the Records[] response: Description.To get all fields, fetch the full record using the Get one WebHook endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "Action": 0,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}