update

POST

/public/webhook/update

• Enclave API server

Update a webhook (team API key).

Request Body ^required

object

uuid

required

The UUID of the webhook to update

string

url

The webhook URL

string format: uri

contentType

Content type for the webhook

string

Allowed values: application/json application/x-www-form-urlencoded

sslVerify

Whether to verify SSL certificates

boolean

active

Whether the webhook is active

boolean

secret

Any of:

string

string

null

null

events

Any of:

Array<string>

Array<string>

null

null

workspaceUuids

Any of:

Array<string>

Array<string>

null

null

title

Any of:

string

string

<= 256 characters

null

null

Responses

200

Default Response

object

webhook

required

object

uuid

required

The UUID of the webhook

string

title

required

Any of:

string

string

null

null

active

required

Whether the webhook is active

boolean

sslVerify

required

Whether SSL verification is enabled

boolean

contentType

required

The content type for the webhook

string

events

required

Any of:

Array<string>

Array<string>

null

null

workspaceUuids

required

Any of:

Array<string>

Array<string>

null

null

creationDate

required

Creation timestamp

number

updateDate

required

Update timestamp

number

400

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: WEBHOOK_NOT_FOUND WORKSPACE_NOT_FOUND WEBHOOK_URL_REFUSED INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object

path

required

JSON path to the invalid field

Array<string>

message

required

Validation error message for this field

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

401

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: AUTHENTICATION_ERROR TUNNEL_ERROR TUNNEL_SESSION_NOT_FOUND INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object

path

required

JSON path to the invalid field

Array<string>

message

required

Validation error message for this field

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

403

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: AUTHORIZATION_ERROR FEATURE_NOT_IN_CURRENT_PLAN INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object

path

required

JSON path to the invalid field

Array<string>

message

required

Validation error message for this field

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

500

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: INTERNAL_SERVER_ERROR INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object

path

required

JSON path to the invalid field

Array<string>

message

required

Validation error message for this field

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string