Skip to main content
POST
Spree Admin SDK

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Bearer token for admin authentication

Body

application/json
url
string
required

HTTPS destination URL. It cannot resolve to a private IP address outside development.

Example:

"https://example.com/webhooks/orders"

name
string | null

A label shown in the dashboard list.

Example:

"Order pipeline"

active
boolean

Defaults to true on create. Prefer the disable and enable endpoints to pause one.

subscriptions
string[]

Event names this endpoint receives. An empty list or ["*"] subscribes to every event; otherwise list exact names (order.completed) or patterns (order.*).

Example:

Response

webhook endpoint created — secret_key returned once