Skip to main content
GET
/
integrations
/
webhooks
List Webhooks
curl --request GET \
  --url http://localhost:3000/v2/integrations/webhooks/ \
  --header 'x-API-Key: <api-key>'
[
  {
    "type": "CREATE",
    "entity": "user",
    "url": "<string>",
    "_id": "<string>",
    "number": 123,
    "companyId": "<string>",
    "status": {
      "status": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedAt": "2023-11-07T05:31:56Z",
      "lastModifiedBy": "<string>"
    }
  }
]

Authorizations

​
x-API-Key
string
header
required

Query Parameters

​
limit
integer
default:100

Maximum number of items to return

Required range: 1 <= x <= 1000
​
offset
integer
default:0

Number of items to skip for pagination

Required range: x >= 0
​
sort
string

Sort field and direction (e.g. number:1, status.createdAt:-1)

Example:

"number:1"

Response

List of Webhooks

​
type
enum<string>
required

The type of the webhook, e.g., CREATE, UPDATE, DELETE

Available options:
CREATE,
UPDATE,
DELETE,
ABSENCE_APPROVED,
ABSENCE_CANCELED,
OPEN
​
entity
enum<string>
required

The entity that the webhook is associated with, e.g., "Absence", "Task"

Available options:
user,
customer,
customerobject,
materialorder,
absence,
complaint,
article,
salary,
job,
qualitycontrol,
invoice,
offer,
credit,
invoicestorno,
servicereport,
payment,
contact,
equipment,
task
​
url
string<uri>
required

The URL to which the webhook will send data

​
_id
string<objectid>

Unique identifier of the entity

​
number
integer

Unique number of the entity, used for identification

​
companyId
string<objectid>

The ID of the company this entity belongs to

​
status
object

Entity Status information