Skip to main content
POST
/
api
/
sync
/
v1
/
webhooks
Register Webhook V1
curl --request POST \
  --url https://api.example.com/api/sync/v1/webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "signing_secret_prefix": "<string>",
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "signing_secret": "<string>",
  "deactivated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.stella-commerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
authorization
string | null
​
X-Stella-Site-Id
string | null
​
X-Sync-Secret
string | null
​
X-Site-ID
string | null
​
Idempotency-Key
string | null

Body

application/json
​
url
string<uri>
required
Required string length: 1 - 2083
​
events
string[]
required
Required array length: 1 - 100 elements
​
description
string | null
Maximum string length: 255

Response

Successful Response

Response shape for POST /webhooks (creation) AND GET /webhooks listing. Note: signing_secret is ONLY populated on the creation response; list responses always omit it (server-side this is set to None on listing).

​
id
string<uuid>
required
​
url
string
required
​
events
string[]
required
​
signing_secret_prefix
string
required
​
is_active
boolean
required
​
created_at
string<date-time>
required
​
description
string | null
​
signing_secret
string | null
​
deactivated_at
string<date-time> | null