Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

Use a project API key from Settings > API Access. Send it as Authorization: Bearer wpk_.... See authentication and scopes for setup and permissions.

Headers

Idempotency-Key
string

Reuse this key for retries of the same write. Scoped to this API key; retained for 30 days, after which the key may be reused. Different requests with the same key return 409.

Required string length: 1 - 128
Pattern: ^[!-~]+$

Body

application/json
url
string
required

Where deliveries are POSTed. https only; must resolve to a public internet host.

Required string length: 1 - 1024
events
string[]
required

Event types to receive: product.created, product.updated, product.deleted.

Required array length: 1 - 16 elements
Required string length: 1 - 32
description
string
default:""

A label for your own reference.

Maximum string length: 255
is_active
boolean
default:true

Inactive subscriptions receive nothing.

Response

Created

id
integer
required
url
string
required
description
string
required
events
string[]
required
is_active
boolean
required
consecutive_failures
integer
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
disabled_reason
string | null

Why WisePIM switched the subscription off: delivery_failures, backlog_full, endpoint_gone, or issuer_revoked (the person who set it up no longer has access to the project).

disabled_at
string<date-time> | null
last_success_at
string<date-time> | null
last_failure_at
string<date-time> | null
last_response_code
integer | null
signing_secret
string | null

The HMAC-SHA256 key for X-WisePIM-Signature. Shown in this response only; null when the response is an Idempotency-Key replay.