Skip to content

Webhooks

These objects represent the outgoing webhooks configured for your organization.

Operations

List webhooks

Request

Retrieve a list of webhook objects configured for your organization

Security
x-api-key
curl -i -X GET \
  https://eu1.api.pushsecurity.com/v1/settings/webhooks \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
resultArray of objects(Webhook)
pagingobject
Response
{
  "result": [
    {
      "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
    }
  ],
  "paging": {
    "moreResults": false,
    "next": "string",
    "nextToken": "string"
  }
}