Search WebHooks

GET

api

sys

webhooks

Search WebHooks

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/webhooks \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/webhooks"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

eWebhookAction — Action values

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

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location this webhook belongs to.

string

Filter by display name for the webhook.

integer

Filter by the event that triggers this webhook (e.g. CoworkerCreate, BookingCreate, CoworkerInvoicePaid).

string

Filter by optional description of the webhook’s purpose.

string

Filter by the endpoint URL that receives the HTTP POST payload when the webhook fires.

boolean

Filter by whether the webhook is enabled and will fire when the configured action occurs.

string

Filter by error message from the most recent failed delivery attempt.

integer

Filter by number of consecutive delivery failures since the last successful call.

string

Filter by date and time the webhook last fired successfully.

Range Filters

integer

Filter by number of consecutive delivery failures since the last successful call greater than or equal to this value.

integer

Filter by number of consecutive delivery failures since the last successful call less than or equal to this value.

string

Filter by date and time the webhook last fired successfully greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date and time the webhook last fired successfully less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

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=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/webhooks?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/webhooks',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

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

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/webhooks?' + new URLSearchParams({
    WebHook_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/webhooks',
    params={
        'WebHook_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/webhooks?' + new URLSearchParams({
    from_WebHook_UpdatedOn: '2025-01-01T00:00',
    to_WebHook_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/webhooks',
    params={
        'from_WebHook_UpdatedOn': '2025-01-01T00:00',
        'to_WebHook_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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
}

Get one WebHookRetrieve a single WebHook record by its Id.

Search WebHooks

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/webhooks \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/webhooks"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200