- Introduction
- User MCP
- Customer MCP
- Booking API
- Building a Lockii App
- Login with Lockii
- Building a Marketplace App
- POSTCreate Webhook
- DELDelete Webhook

Create Webhook

Register a URL for account webhook deliveries. eventType is stored comma-separated. A delivery matches when one of those names is the event, or the stored value is *. Any API key for the company can manage webhooks.

POST

/api/v1/webhook

POST

/webhook

curl -X POST "https://dash.lockii.app/api/v1/webhook" \
  -H "x-api-key: $LOCKII_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "eventType": [
    "string"
  ],
  "url": "string"
}'

Authorization

x-api-key
string
header
API key from Settings → Integrations → API.
Authorization
string
header
The same API key, or an OAuth access token, sent as Authorization: Bearer.
api_key
string
query
API key query parameter.

Body

application/json

eventType
string[]
required
Account event names, or * for every account event. One name matches deliveries of that event.
url
string
required
URL that receives the JSON POST.

Response

application/json

JSON result for this operation.

companyId
string
required
eventType
string
required
Comma-separated event names, or * for every account event.
id
string
required
Webhook id, webhook_<uuid>.
url
string
required

{
  "companyId": "string",
  "eventType": "string",
  "id": "string",
  "url": "string"
}