Skip to main content
POST
Create a new webhook (account-wide).
The signing secret is returned once, here, and never again. There is no endpoint or dashboard screen that will show it later. Store it when you receive it; if you lose it, your only option is to delete the webhook and create a new one.
You can hold up to 25 webhooks per user, each scoped to one or more of your stores. URLs must be HTTP or HTTPS, and any that resolve to private or reserved addresses are rejected.

Authorizations

Authorization
string
header
required

Your API key goes here

Body

application/json

The Komerza.Common.Forms.Users.WebhookForm containing URL, events, and store IDs

Represents a form for configuring webhooks. This form includes a URL for the webhook, a list of event types, and a list of store IDs the webhook should apply to.

url
string<uri>
required

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

Minimum string length: 1
Pattern: ^https?://.*
eventTypes
string[]
required

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

Required array length: 1 - 9999 elements
storeIds
string<uuid>[]
required

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

Required array length: 1 - 999 elements

Response

The object was successfully created.

Represents a default generic response for API endpoints.

success
boolean
required

Indicates whether the operation or response was successful.

message
string | null

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

code
string | null

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

data
object
Last modified on August 2, 2026