Create a webhook configuration

Create a new webhook configuration for a specified workspace.

SecurityJWT
Request
header Parameters
Workspace
required
string

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
Request Body schema: application/json
name
required
string
description
string
applyToAllDescendants
required
boolean
url
required
string
secret
required
string
object
triggers
required
Array of strings unique
Items Enum: "workspaceCreated.v1" "workspaceStatusUpdated.v1" "subscriptionUpdated.v1" "protectedUsersAdded.v1" "protectedUsersUpdated.v1" "protectedUsersDeleted.v1" "protectedDevicesUpdated.v1" "protectedDevicesAdded.v1" "protectedDevicesDeleted.v1" "protectedDevicesCountUpdated.v1"
Responses
201

Created

400

Bad request, validation error

401

Unauthorized request

403

Access forbidden

429

Too Many Requests

500

Internal server error

post/v1/settings/webhooks
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "applyToAllDescendants": true,
  • "url": "string",
  • "secret": "string",
  • "headers": {
    },
  • "triggers": "workspaceCreated.v1"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "workspaceId": "string",
  • "status": "enabled",
  • "description": "string",
  • "applyToAllDescendants": true,
  • "url": "string",
  • "secret": "string",
  • "headers": {
    },
  • "triggers": "workspaceCreated",
  • "created": 0,
  • "updated": 0
}