Save webhook

PUT

/api/v1/instance/audit/webhook

curl --request PUT \
  --url https://example.com/api/v1/instance/audit/webhook \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <X-CSRF-Token>' \
  --cookie ttx_access_token=<ttx_access_token> \
  --data '{ "authorization": "example", "enabled": true, "url": "example" }'

Where the log goes: every event from now on is forwarded (the ones before can be exported). Recorded, with step-up – it sends account emails out of the deployment.

Authorizations

• csrfToken
• sessionCookie

Request Body^required

Media typeapplication/json

AuditWebhookUpdateRequest

object

authorization

Any of:

string

string

<= 1000 characters

null

null

enabled

Enabled

boolean

default: true

url

required

Url

string

>= 1 characters <= 2000 characters

Responses

200

Successful Response

Media typeapplication/json

AuditWebhookRead

object

allow_http

required

Allow Http

boolean

configured

required

Configured

boolean

enabled

Enabled

boolean

has_authorization

Has Authorization

boolean

last_error

Any of:

string

string

null

null

last_failure_at

Any of:

string

string format: date-time

null

null

last_status

Any of:

integer

integer

null

null

last_success_at

Any of:

string

string format: date-time

null

null

pending

Pending

integer

0

secret

Any of:

string

string

null

null

url

Any of:

string

string

null

null

Example

{
  "enabled": false,
  "has_authorization": false,
  "pending": 0
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}