Skip to main content
POST
Create a new webhook

Authorizations

x-API-Key
string
header
required

Body

application/json

Webhook data

A webhook that can be triggered on specific events.

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

Response

Webhook created successfully

_id
string