Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Your Merchant API key. Create one in Dashboard → Developers → API keys.

Path Parameters

storeId
string
required

Your store id. Find it in Dashboard → Developers, or in GET /stores with MCP.

webhookId
string
required

Webhook id. Accepts the internal id or the public id (for example PRD-…).

Body

application/json
name
string
Required string length: 1 - 120
url
string<uri>
Maximum string length: 2048
events
enum<string>[]
Minimum array length: 1
Available options:
order.created,
order.completed,
order.refunded,
product.updated
enabled
boolean

Response

The webhook.

The response is of type object.