Skip to main content
POST
/
api
/
sync
/
webhook
/
register
Register Webhook
curl --request POST \
  --url https://api.example.com/api/sync/webhook/register \
  --header 'Content-Type: application/json' \
  --header 'X-Site-ID: <x-site-id>' \
  --header 'X-Sync-Secret: <x-sync-secret>' \
  --data '
{
  "url": "<string>",
  "events": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "created_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

X-Sync-Secret
string
required
X-Site-ID
string
required

Body

application/json

Schema for registering a webhook.

url
string
required
events
string[]
required

Response

Successful Response

Schema for webhook in responses.

id
string
required
url
string
required
events
string[]
required
created_at
string<date-time>
required