HAhappyscribe
Webhook endpoints

Update a webhook endpoint

Omitted fields keep their values. Disabling an endpoint stops its deliveries, retries included. Moving api_version changes the shape of every event sent from then on, retries included.

patch/webhook_endpoints/{id}

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Request body

urlstring

A public HTTPS URL.

enabled_eventsstring[]

Replaces the whole list.

namestring nullable

A new name.

status'enabled' | 'disabled'

Turn it on or off.

  • enabled: receives events.
  • disabled: receives nothing; disabling cancels its pending deliveries.
api_versionstring

The version its events are named and shaped at, from now on.

Example request

{
  "api_version": "2026-10-09"
}

Response

The updated endpoint.

idstring

Webhook endpoint ID, beginning with whe_. Treat it as an opaque string.

objectstring

Always webhook_endpoint.

workspace_idstring

Workspace ID, beginning with wks_. Treat it as an opaque string.

namestring

Defaults to the URL's host.

urlstring uri

The public HTTPS URL events are sent to.

enabled_eventsstring[]

The events it receives, named as its api_version names them. * is every event.

status'enabled' | 'disabled'

Whether it receives events.

  • enabled: receives events.
  • disabled: receives nothing; disabling cancels its pending deliveries.
api_versionstring date

The version its events are named and shaped at.

metadataMetadata

Your own key-value pairs, for your ids and context. HappyScribe stores them, returns them on the object and in every webhook that carries it, and never acts on them. Up to 50 keys of up to 40 characters (no square brackets), values up to 500 characters. See metadata.

created_atstring date-time

When it was created, in ISO 8601.

updated_atstring date-time

When it last changed, in ISO 8601.

Example response

{
  "id": "whe_01k6d4a1b2c3d4e5f6g7h8j9km",
  "workspace_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab",
  "name": "Acme production",
  "url": "https://api.acme.com/happyscribe/webhooks",
  "enabled_events": [
    "meeting.finished",
    "bot.summary_ready"
  ],
  "api_version": "2026-10-09",
  "metadata": {
    "gurusup_user_id": "usr_8812"
  }
}

Changes

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