Notifications

Update webhook config

Changed on

Update webhook config.

Auth: Required (bearer token). Scope: Organization-scoped in authenticated context. Side effects: May mutate server state.

put/api/v1/notification/webhook

Request

  • Base URL
    http://:8080
  • URL
    http://:8080/api/v1/notification/webhook
  • Auth
    none declared

Headers

Acceptstring

Request body */*

is_activeboolean nullable

Whether the webhook integration is active

typestring required

Webhook integration type

webhook_urlstring nullable

Updated webhook URL

Example request

{
  "is_active": true,
  "type": "slack",
  "webhook_url": "https://hooks.slack.com/services/..."
}

Response

OK

messagestring
statusstring

Changes

    • info

      api tag Notifications added

    • info

      api tag api/v1/notification removed

    • info

      api tag webhook removed

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/xml)