Update a webhook target

PATCH

/organizations/{org_id}/webhooks/{target_id}

curl --request PATCH \
  --url https://api.perstat.io/organizations/example/webhooks/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "active": true, "credential": "example", "events": [ "example" ], "name": "example", "region": "example", "url": "example" }'

• Production

Partially updates a webhook or Slack target: name, destination URL, subscribed event list, and active flag. Omitted fields keep their current value; the URL and event names are validated, and an explicitly empty name returns 400. The signing secret cannot be changed here, use the rotate-secret operation.

Authorizations

• bearer

Parameters

Path Parameters

org_id

required

string

target_id

required

string

Request Body^required

Media typeapplication/json

object

active

boolean | null

credential

Ersetzt den Anbieter-Schlüssel (PagerDuty/Opsgenie), z. B. nachdem er dort rotiert wurde. Für den generischen Webhook gibt es stattdessen rotate-secret (server-erzeugtes Signatur-Secret).

string | null

events

Array<string> | null

name

string | null

region

Wechselt die Anbieter-Region (global | eu) und damit den Endpunkt.

string | null

url

Nur für Arten mit kundeneigener Adresse.

string | null

Example^generated

{
  "active": true,
  "credential": "example",
  "events": [
    "example"
  ],
  "name": "example",
  "region": "example",
  "url": "example"
}

Responses

200

Media typeapplication/json

object

active

required

boolean

created_at_unix

required

integer format: int64

events

required

Array<string>

id

required

Public_id (wht_…).

string

kind

required

Benannte Art: slack | teams | discord | google_chat | pagerduty | opsgenie | webhook.

string

last_delivery_at_unix

integer | null format: int64

last_delivery_ok

boolean | null

last_error

string | null

name

required

string

region

Anbieter-Region bei pagerduty/opsgenie (global | eu), sonst null. Wird aus dem gespeicherten Endpunkt zurückgewonnen.

string | null

secret_hint

Maskierter Hinweis auf das gespeicherte Geheimnis (Signatur-Secret beim generischen Webhook, Anbieter-Schlüssel bei PagerDuty/Opsgenie). Das volle Signatur-Secret gibt es genau EINMAL beim Anlegen bzw. der Rotation; einen Anbieter-Schlüssel gibt die API NIE zurück.

string | null

url

required

string

Example^generated

{
  "active": true,
  "created_at_unix": 1,
  "events": [
    "example"
  ],
  "id": "example",
  "kind": "example",
  "last_delivery_at_unix": 1,
  "last_delivery_ok": true,
  "last_error": "example",
  "name": "example",
  "region": "example",
  "secret_hint": "example",
  "url": "example"
}

400

401

403

404