# Update a webhook endpoint

Adresse: https://docs.athaus.ai/api/v1/referenz/update-webhook-endpoint

> Aufruf, Parameter, Antwort und Fehler von PATCH /v1/webhookEndpoints/{id}.

Typ: Referenz
Zuletzt aktualisiert: 2026-11-14

Merge Patch: a missing field stays, `description: null` clears the note, `events` replaces the list. `disabled: true` stops deliveries, `disabled: false` turns a disabled endpoint on again (the URL is checked again). The key needs read access to the resource of every event type the endpoint ends up with, otherwise 403. Needs write access to `webhookEndpoints`.

Braucht den Scope [`propose`](/api/v1/anmeldung#scopes).

## Aufruf [#aufruf]

```http
PATCH https://api.athaus.ai/v1/webhookEndpoints/{id}
```

### Parameter [#parameter]

**Pfad**

| Name | Typ             | Pflicht | Beschreibung                  |
| ---- | --------------- | ------- | ----------------------------- |
| `id` | `string (uuid)` | ja      | UUID of the webhook endpoint. |

**Kopf**

| Name             | Typ      | Pflicht | Beschreibung                                                                                                                                                 |
| ---------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Athaus-Version` | `string` | nein    | Optional and carries nothing a client needs: the version is the path. Accepted when it says `v1` or `1`. Any other value is a 400 `api_version_unsupported`. |
| `If-Match`       | `string` | nein    | Only if the current ETag of the resource is listed (or `*`: only if the resource exists). Otherwise 412 and nothing is written.                              |

### Rumpf [#rumpf]

JSON mit `Content-Type: application/json`. Ein Feld, das die API nicht kennt, ist ein `400`, und `errors[].name` nennt das Feld. Der Rumpf ist Pflicht.

| Feld          | Typ              | Beschreibung                                                                                                                                                                                                                                                                                              |
| ------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url`         | `string`         | Where deliveries go: an `https` URL on a public address, without credentials.                                                                                                                                                                                                                             |
| `events`      | `string[]`       | The event types this endpoint receives. The key needs read access to the resource of each. Eines von `inquiry.received`, `message.received`, `viewing.booked`, `viewing.canceled`, `viewing.upcoming`, `file.processed`, `proposal.pending`, `project.created`, `project.updated`, `unit.status_updated`. |
| `description` | `string \| null` | `null` clears the note.                                                                                                                                                                                                                                                                                   |
| `disabled`    | `boolean`        | `true` stops deliveries, `false` turns a disabled endpoint on again and clears the reason.                                                                                                                                                                                                                |

### Beispiel [#beispiel]

```bash
curl -X PATCH "https://api.athaus.ai/v1/webhookEndpoints/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
  -H "Authorization: Bearer ath_live_..." \
  -H "Content-Type: application/json" \
  -d '{"events":["inquiry.received","message.received"]}'
```

## Antwort [#antwort]

Bei Erfolg kommt `200` mit `WebhookEndpoint`.

### WebhookEndpoint [#webhookendpoint]

| Feld                        | Typ                          | Beschreibung                                                                                                                                                                                                                                                                                                                                                                                                               |
| --------------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `object`                    | `string`                     | Immer `webhook_endpoint`.                                                                                                                                                                                                                                                                                                                                                                                                  |
| `id`                        | `string`                     | UUID of the endpoint.                                                                                                                                                                                                                                                                                                                                                                                                      |
| `url`                       | `string`                     |                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `description`               | `string \| null`             |                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `events`                    | `string[]`                   |                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `status`                    | `string`                     | A disabled endpoint receives nothing. Eines von `enabled`, `disabled`.                                                                                                                                                                                                                                                                                                                                                     |
| `disabledReason`            | `string \| null`             | Why it is disabled. `disabled_by_user`: you set `disabled`. `target_not_allowed`: the address is not public any more. `endpoint_gone`: the receiver answered 410. `delivery_failing`: no delivery succeeded for five days, and Athaus switched it off by itself. `key_revoked`: the API key that created it ended. Eines von `disabled_by_user`, `target_not_allowed`, `endpoint_gone`, `delivery_failing`, `key_revoked`. |
| `disabledAt`                | `string (date-time) \| null` | When the endpoint was switched off, by you or by Athaus; null while it is enabled. Not set for `key_revoked`: read the key list for that.                                                                                                                                                                                                                                                                                  |
| `apiVersion`                | `string`                     | The API version the payloads are shaped in.                                                                                                                                                                                                                                                                                                                                                                                |
| `apiKeyId`                  | `string`                     | UUID of the API key this endpoint belongs to. When that key ends, the endpoint stops delivering.                                                                                                                                                                                                                                                                                                                           |
| `secretRotationEndsAt`      | `string (date-time) \| null` | While a rotation runs: until when the previous secret also signs.                                                                                                                                                                                                                                                                                                                                                          |
| `lastDelivery`              | `object \| null`             |                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `lastDelivery.at`           | `string (date-time)`         | When the last attempt ran.                                                                                                                                                                                                                                                                                                                                                                                                 |
| `lastDelivery.status`       | `integer \| null`            | The HTTP status of the receiver, or null if it never answered.                                                                                                                                                                                                                                                                                                                                                             |
| `lastDelivery.error`        | `string \| null`             | `connection_refused`, `timeout`, `tls_error`, `http_4xx`, `http_5xx` or `address`; null if it succeeded.                                                                                                                                                                                                                                                                                                                   |
| `lastDelivery.failingSince` | `string (date-time) \| null` | Since when every attempt fails; null if the last one succeeded.                                                                                                                                                                                                                                                                                                                                                            |
| `createdAt`                 | `string (date-time)`         |                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `updatedAt`                 | `string (date-time)`         |                                                                                                                                                                                                                                                                                                                                                                                                                            |

### Köpfe der Antwort [#köpfe-der-antwort]

| Kopf               | Beschreibung                                                                                                                                                                            |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Request-Id`       | Identifies this request. Quote it in a support request.                                                                                                                                 |
| `Athaus-Version`   | The API version of this response: v1.                                                                                                                                                   |
| `Athaus-Release`   | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.                                                                         |
| `ETag`             | A strong entity tag of this state of the resource. Send it as `If-Match` to change or delete the resource only if it is unchanged, or as `If-None-Match` to read it only if it changed. |
| `RateLimit-Policy` | The quota policy of the bucket that applies.                                                                                                                                            |
| `RateLimit`        | Remaining quota and seconds until the bucket is full again.                                                                                                                             |

## Fehler [#fehler]

Jeder Fehler kommt als [Problem Details](/api/v1/fehler). Verzweige auf `code`, nicht auf `title` oder `detail`.

| Status | Codes                                                                                                                                                                                              | Bedeutung                                                                                                                  |
| ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `400`  | [`invalid_id`](/api/errors#invalid_id), [`api_version_unsupported`](/api/errors#api_version_unsupported), [`invalid_input`](/api/errors#invalid_input), [`invalid_body`](/api/errors#invalid_body) | Invalid request.                                                                                                           |
| `401`  | [`unauthorized`](/api/errors#unauthorized)                                                                                                                                                         | Missing or invalid API key.                                                                                                |
| `403`  | [`insufficient_permissions`](/api/errors#insufficient_permissions), [`plan_required`](/api/errors#plan_required)                                                                                   | The key lacks a right, or the plan does not include API access.                                                            |
| `404`  | [`not_found`](/api/errors#not_found)                                                                                                                                                               | Nothing under this ID.                                                                                                     |
| `409`  |                                                                                                                                                                                                    | The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key.                |
| `412`  | [`precondition_failed`](/api/errors#precondition_failed)                                                                                                                                           | The condition of `If-Match` (or `If-None-Match`) does not hold for the current state of the resource. Nothing was written. |
| `413`  | [`payload_too_large`](/api/errors#payload_too_large)                                                                                                                                               | The request body is larger than 512 KB.                                                                                    |
| `415`  | [`invalid_input`](/api/errors#invalid_input)                                                                                                                                                       | The request body is not JSON. Send `Content-Type: application/json`.                                                       |
| `429`  | [`rate_limited`](/api/errors#rate_limited)                                                                                                                                                         | Rate limit exceeded.                                                                                                       |
| `500`  | [`internal_error`](/api/errors#internal_error)                                                                                                                                                     | Server error.                                                                                                              |
