Sign in
Webhook

Create a new webhook (account-wide).

Allows the user to specify multiple store IDs in Komerza.Common.Forms.Users.WebhookForm.StoreIds. Requires the user.webhooks.create permission.

post/webhooks

Request body

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.

Response

The object was successfully created.

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

Changes

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