Skip to content
/
Update webhook

Update webhook

Request

Update a webhook.

Security
x-api-key
Path
idstringrequired

Unique identifier for the webhook

Bodyapplication/jsonrequired
enabledbooleanrequired

Whether the webhook should be enabled.

Example:false
curl -i -X PATCH \
  'https://eu1.api.pushsecurity.com/v1/settings/webhooks/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "enabled": false
  }'

Responses

OK

Bodyapplication/json
idstring

Unique identifier for this object

Example:"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"
urlstring or null

The URL called by this webhook

Example:"https://example.com/webhook"
enabledboolean

Whether the webhook is enabled

Example:true
eventsobject

The events that are sent from this webhook.

customHeadersConfiguredboolean

Whether the webhook has custom headers configured

Example:false
creationTimestampinteger

When the webhook was created, formatted as a UNIX timestamp (in seconds)

Example:1698064423
lastUpdatedTimestampinteger

When the webhook was last updated, formatted as a UNIX timestamp (in seconds)

Example:1698064423
Response
{
  "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
  "url": "https://example.com/webhook",
  "enabled": true,
  "events": {
    "objects": [
      "API_KEY_ADDED",
      "CONTROL_RULE_UPDATED"
    ],
    "categories": [
      "AUDIT",
      "CONTROL"
    ]
  },
  "customHeadersConfigured": false,
  "creationTimestamp": 1698064423,
  "lastUpdatedTimestamp": 1698064423
}