Webhook

Update an existing webhook

Overwrites the URL, events, and store IDs. Requires the user.webhooks.update permission.

put/webhooks/{webhookId}

Request

Base URL
https://api.komerza.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/komerza/apis/komerza-api/docs/webhooks/:webhookId/put.ts
A function with typed inputs. Its response is checked against the schema.

webhookIdstring uuid required

ID of the webhook to update

urlstring uri required

The URL associated with this webhook. Required and must be a valid URL.

eventTypesstring[] required

The event types this webhook should subscribe to. Must contain at least one entry.

storeIdsstring[] required

The list of store IDs to which this webhook will be linked.

The object was successfully updated.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error

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