Skip to content
ZUTAX ZUTAX Documentation

Update webhook

PUT
/api/v1/tenants/{tenant_id}/workspaces/{workspace_id}/webhooks/{webhook_id}

Update webhook configuration.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
webhook_id
required
Webhook Id
string format: uuid

Header Parameters

Section titled “Header Parameters ”
X-Workspace-ID
Any of:
string
X-API-Key
Any of:
string
X-Tenant-ID
Any of:
string

Request Body required

Section titled “Request Body required ”
WebhookUpdate

Update webhook request.

object
url
Any of:
string
<= 500 characters
events
Any of:
Array<string>
>= 1 items
secret
Any of:
string
<= 255 characters
is_active
Any of:
boolean
Examples

Request payload example

{
  "url": "string",
  "events": [
    "string"
  ],
  "secret": "string",
  "is_active": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Examples

200 response example

{
  "status": "ok",
  "message": "Request completed successfully."
}

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examples

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}