Webhooks

Update a webhook endpoint

Partially update a webhook endpoint. Either field may be omitted.

Setting event_types replaces the full list of subscriptions for this endpoint.
Updating either field resets the endpoint status to unverified; you must call verify again before the endpoint will receive events.

patch/api/v3/webhook_endpoints/{id}/

Request

Base URL
https://embedded.improvado.io
Auth
- HTTP bearer
- or API key in cookie dts_session_id
TypeScript
https://skmtc.dev/improvado/apis/improvado-embedded-api-v3/docs/api/v3/webhook_endpoints/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

idinteger required

Webhook endpoint ID

urlstring uri

event_typesstring[]

Webhook endpoint updated

idinteger

urlstring uri

secretstring

64-character hex signing secret

status'unverified' | 'active'

consecutive_failuresinteger

created_atstring date-time

updated_atstring date-time

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