API Docs / Operations / Webhooks / Update Webhook

Update Webhook

PUT /tenants/{tenant}/webhooks/{webhook}

Replaces the webhook's name, URL, enabled flag and events; the secret is kept. Setting enabled switches a webhook back on after it was switched off for repeated failures.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

webhook* path string (uuid)

Request Body*

{
  "name": "string",
  "url": "string",
  "enabled": false,
  "events": [
    "TestWebhook"
  ]
}

Responses

400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
404 Not Found
application/problem+json