API ReferenceChangelog
HomeAPI ReferenceChangelog
API ReferenceChangelogLog In
API Reference

/webhooks/:id

patch
https://api.vergesense.com/webhooks/

Update a webhook.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Example Patch Updates

DescriptionRequest Body
Update the name of a webhook.
{
    "name": "New Name"
}
Update the webhook to be enabled. Note that this can also be done through the /enabled and /disabled endpoints.
{
    "enabled": true
}
Update the webhook parameters. Note that EVENT_ENDPOINT must always be included even if it is not being updated. The PATCH will replace the previous parameters object and so all keys that wish to be retained as well as those that are to be updated must be included.
{
     "parameters": {
          "CUSTOM_HEADERS": {
               "my-api-key": "987"
          },
          "EVENT_ENDPOINT": "https://example.com"
     }
}
Update the buildings that a webhook is filtered to.
{
    "filters": {
        "building_ids": [123]
    }
}
Path Params
string
required

Webhook ID

Responses

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago