Sifely Open API
  1. Webhooks
Sifely Open API
  • Overview
  • Quick start
  • API Use Cases
    • Hospitality & Vacation Rental
  • OAuth Manager
    • Login
      POST
    • Get authorization_code
      POST
    • Get token refresh token
      POST
  • Key Manager
    • Get Ekeys by account
      POST
    • Send ekey
      POST
    • Delete ekey
      POST
  • Passcode Manager
    • Random a passcode with offline
      POST
    • Create passcode
      POST
    • Change passcode
      POST
    • Delete passcode
      POST
    • Get passcode
      GET
  • Lock Manager
    • Unlock a lock via gateway
      POST
    • Lock the lock via gateway
      POST
    • Get lock details
      GET
    • Get keys of a lock
      GET
    • Passcode list
      GET
    • Get Lock open state
      GET
    • Get the owner lock list of an account
      POST
  • Group Manager
    • Group list
      GET
  • Card Manager
    • Get IC card list
    • Assigns IC card
    • Delete a IC card from a lock
  • FingerPrint Manager
    • FingerPrint list
  • Records Manager
    • Get unlock records by lockId
  • Gateway Manager
    • Gateway details
    • Lock's gateways
    • Gateway's locks
  • Webhooks
    • Setup & Authentication
    • Payload Reference
  • Schemas
    • KeyInfo
    • CardInfo
    • FingerInfo
    • CardAddDTO
    • GroupInfo
    • LockDetailDTO
    • LockVersion
    • GatewayDetailDTO
    • OpenStateDTO
    • OauthDTO
    • PwdAddDTO
    • PwdInfo
    • ListByLockDTO
    • ListData«ListByLockDTO»
    • YesOrNotDTO
    • Page«CardInfo»
    • Page«FingerInfo»
    • ListData«ListLockDTO»
    • ResultWrapper«Map«string,string»»
    • Page«GroupInfo»
    • ListLockDTO
    • Page«KeyInfo»
    • Page«PwdInfo»
    • Page«RecordInfo»
    • RecordInfo
    • ResultWrapper«SysAppClientDetails»
    • ResultWrapper«object»
    • SysAppClientDetails
  1. Webhooks

Setup & Authentication

Sifely webhooks allow your application to receive real-time notifications about smart lock events (such as unlocking, low battery alerts, etc.) without the need for constant API polling.

1. Configurations#

To start receiving real-time data, follow these steps:
Authentication: Log in to your developer account at the Access Page.
Endpoint Setup: Navigate to the Webhooks section.
Configure URL: Enter your server's destination URL (e.g., https://your-api.com/webhooks/sifely).
Verification: Click "Save". Our system will send a test request to this URL. Your server must return a 200 OK status code to complete the activation.

2. Logic & Trigger#

The Webhook lifecycle follows a three-step process:
Device Binding: Once a user successfully imports a Sifely lock into their platform account, the device is linked to your Client ID.
Event Occurrence: An event is triggered at the lock (e.g., App unlocking, Passcode entry, Fingerprint scan, or IC Card swipe).
Instant Push: The Sifely Cloud immediately pushes a structured JSON payload to your configured Webhook URL.
Modified at 2026-02-10 11:18:30
Previous
Gateway's locks
Next
Payload Reference
Built with