Webhooks

Developing

POST

/settings/webhooks

Programmatically register webhooks for properties, assets, contracts, opportunities, jobs and appointments

Request

Query Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401401 Unauthorised

🟠403403 Forbidden

🟠404404 Not found

🟠409409 Conflict

🟠429429 Too many requests

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/settings/webhooks?description=New%20job%20creation%20for%20updating%20marketing%20system&object=jobs&eventTypes=jobs.created&targetURL=undefined'

Response Example

200 - Example 1

{
    "id": 0,
    "description": "string",
    "object": "string",
    "eventTypes": [
        "string"
    ],
    "targetURL": "string",
    "signingSecret": "string"
}

Modified at 2026-04-29 12:04:50

Example PHP script

Webhooks