Account

Update an account webhook endpoint

Partially update an account webhook endpoint: url, enabled_events, account_relationship, description, api_version or status.

  • Omitted fields keep their value; description: null clears it; status toggles active/disabled.
  • Requires a live key; 404 webhook_endpoint_not_found.
patch/accounts/{account}/webhooks/{webhook}

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/accounts/{account}/webhooks/{webhook}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

accountstring uuid required

Public identifier (UUID v7) of your account. Get it from GET /v1/me (data.account.id).

webhookstring uuid required

Public identifier (UUID v7) of the webhook endpoint.

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

urlstring

New HTTPS URL that receives the signed events (up to 2048 characters). Cannot be null.

enabled_eventsstring[]

Complete new list of event types (at least one): the company events of the public catalog and the account.* events (AccountEventType). It replaces the current list and cannot be null.

account_relationship'own' | 'managed' | 'all'

New relationship filter: own, managed or all. Cannot be null.

descriptionstring nullable

New free text (up to 255 characters); null clears it.

api_versionstring

New payload version (YYYY-MM-DD) to pin the endpoint to. Cannot be null; an unsupported one returns 422 with its own subcode.

status'active' | 'disabled'

Optional endpoint status: active re-enables the endpoint and disabled pauses it; omit it to leave the status unchanged. Cannot be null. Re-enabling an endpoint that the engine disabled because its creator lost the capability makes the caller its new creator.

Response

Example response

{
  "data": {
    "id": "01933b70-8a41-7c3e-9d52-4b6e8f1a2c01",
    "object": "account_webhook",
    "environment": "live",
    "url": "https://example.com/hooks/factuarea-account",
    "enabled_events": [
      "invoice.created",
      "account.member_added"
    ],
    "account_relationship": "all",
    "status": "active",
    "api_version": "2026-10-05",
    "description": "Alerts of the account.",
    "created_at": "2026-09-28T10:15:00+00:00",
    "updated_at": "2026-09-28T10:15:00+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.