Skip to main content
id
string
required

Unique identifier for the webhook

label
string
required

Human-readable label for the webhook

Maximum string length: 255
url
string<uri>
required

URL where webhook events will be sent

events
enum<string>[]
required

List of events this webhook subscribes to

Webhook event for when an API key is created

Available options:
api_key.created
Example:

"product.created"

description
string | null
required

Description for the webhook

created_at
string<mysql-date-time>
required

Timestamp when the webhook was created

Example:

"2025-06-29 16:03:44"

updated_at
string<mysql-date-time> | null
required

Timestamp when the webhook was last updated

Example:

"2025-06-29 16:03:44"

secret
string

Secret used to sign webhook payloads

enabled
number
default:1

Indicates if the webhook is currently enabled

day_metrics
object
hourly_metrics
object[] | null

Hourly metrics for the last 24 hours