Webhook

INFO

Webhooks werden von Triggern über den Parameter notification.webhook zur Aktions-Ausführung angesprochen ({"notification.webhook": {"webhook_id": <id>}}). Erstellen Sie zunächst den Webhook und verweisen Sie anschließend in einem oder mehreren Triggern auf dessen id.

Auflisten

Erforderliche Berechtigung: admin.webhook

GET-Request gesendet: /api/v1/webhooks

Details

// HTTP-Code 200 OK

[
  {
    "id": 1,
    "name": "Example webhook",
    "endpoint": "https://example.com/webhooks/incoming",
    "http_method": "post",
    "signature_token": "**********",
    "ssl_verify": true,
    "basic_auth_username": "user",
    "basic_auth_password": "**********",
    "bearer_token": null,
    "note": "Notifies an external system about ticket updates.",
    "pre_defined_webhook_type": null,
    "customized_payload": false,
    "custom_payload": null,
    "preferences": {},
    "active": true,
    "updated_by_id": 3,
    "created_by_id": 3,
    "created_at": "2026-09-24T12:31:34.578Z",
    "updated_at": "2026-09-24T12:31:44.512Z"
  }
]

INFO

signature_token, basic_auth_password und bearer_token werden nach ihrer Festlegung als ********** zurückgegeben. Die API gibt die gespeicherten Geheimnisse niemals aus. Felder, die nicht gesetzt sind, werden als null ausgegeben.

Anzeigen

Erforderliche Berechtigung: admin.webhook

GET-Request gesendet: /api/v1/webhooks/{id}

Details

// HTTP-Code 200 OK

{
  "id": 1,
  "name": "Example webhook",
  "endpoint": "https://example.com/webhooks/incoming",
  "http_method": "post",
  "signature_token": "**********",
  "ssl_verify": true,
  "basic_auth_username": "user",
  "basic_auth_password": "**********",
  "bearer_token": null,
  "note": "Notifies an external system about ticket updates.",
  "pre_defined_webhook_type": null,
  "customized_payload": false,
  "custom_payload": null,
  "preferences": {},
  "active": true,
  "updated_by_id": 3,
  "created_by_id": 3,
  "created_at": "2026-09-24T12:31:34.578Z",
  "updated_at": "2026-09-24T12:31:44.512Z"
}

Erstellen

Erforderliche Berechtigung: admin.webhook

POST-Request gesendet: /api/v1/webhooks

Details

{
  "name": "Example webhook",
  "endpoint": "https://example.com/webhooks/incoming",
  "http_method": "post",
  "signature_token": "your-signature-token",
  "ssl_verify": true,
  "customized_payload": false,
  "note": "Notifies an external system about ticket updates.",
  "active": true
}

INFO

ssl_verify ist für https:// Endpunkte von Bedeutung; setzen Sie den Wert auf true, um das TLS-Zertifikat des Endpunkts zu überprüfen. Es ist nur für einen reinen http:// Endpunkt sinnvoll, den Wert auf false zu setzen, falls dieser gar kein Zertifikat besitzt, das überprüft werden kann.

Aktualisierung

Erforderliche Berechtigung: admin.webhook

PUT-Request gesendet: /api/v1/webhooks/{id}

Die Struktur der Nutzlast entspricht der von Create. Die Antwort besteht aus dem aktualisierten Datensatz, dessen Struktur der von Show/Create entspricht, wobei updated_at aktualisiert wird.

TIP

Auch eine teilweise Nutzlast funktioniert, z.B. {"active": false}, um nur dieses Feld umzuschalten.

Details

{
  "name": "Example webhook",
  "endpoint": "https://example.com/webhooks/incoming",
  "http_method": "post",
  "signature_token": "your-signature-token",
  "ssl_verify": true,
  "customized_payload": false,
  "note": "Notifies an external system about ticket updates.",
  "active": true,
  "id": 1
}

Löschen

Erforderliche Berechtigung: admin.webhook

DANGER

Dies ist eine dauerhafte Entfernung

Bitte beachten Sie, dass das Entfernen von Webhooks nicht rückgängig gemacht werden kann.

Ein Webhook, der noch von der perform Aktion eines anderen Objekts (z.B. einem Trigger) referenziert wird, kann nicht gelöscht werden. Die API antwortet mit 422 Unprocessable Entity und listet die referenzierenden Objekte auf. Entfernen Sie zuerst diese Referenzen.

DELETE-Request gesendet: /api/v1/webhooks/{id}

Details

// HTTP-Code 200 OK

{}

Details

// HTTP-Code 422 Unprocessable Entity

{
  "error": "This object is referenced by other object(s) and thus cannot be deleted: %s",
  "error_human": "This object is referenced by other object(s) and thus cannot be deleted: %s",
  "unprocessable_content": [
    "Trigger / Notify customer on auto-close (#5)"
  ]
}