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

Payload Reference

1. Sample Payload#

When an event occurs, Sifely sends an application/json POST request to your endpoint.
Note: The records field is a JSON-formatted string. You must parse it into an array to access individual record properties.
JSON
{
    "lockId": "24300262",
    "lockMac": "07:C4:5A:CF:5E:67",
    "records": "			     			[{\"lockId\":24300262,\"electricQuantity\":100,\"serverDate\":1770703981459,\"recordTypeFromLock\":4,\"recordType\":4,\"success\":1,\"lockMac\":\"07:C4:5A:CF:5E:67\",\"keyboardPwd\":\"3722\",\"lockDate\":1770703973000,\"username\":\"715-2\"}]",
    "notifyType": "1",
    "admin": "demo@sifely.com"
}

2. Field Definitions#

2.1 Root Object (Wrapper)#

FieldValueDescriptions
lockId24300262Unique identification ID of the lock.
lockMac07:C4:5A:CF:5E:67MAC address of the lock.
notifyType1Notification category
admindemo@sifely.comadmin account
records-Stringified JSON Array containing the event details.

2.2 Record Object (Inside the records string)#

FieldValueDescriptions
username715-2Name of the person who operated the lock.
recordType4The specific event code (see Event Tables below).
success1Operation status: 1 for Success, 0 for Failure.
electricQuantity100Current battery level percentage (0–100).
keyboardPwd3722The passcode value used (only for passcode events).
lockDate1770703973000Time recorded by the lock hardware (Unix ms).
serverDate1770703981459Time the event reached the Sifely cloud (Unix ms).
lockId24300262the unique identification id

2.3 Event Type Catalog#

Unlock Events#

User-initiated actions that successfully open the door.
recordTypeDescriptions
1Bluetooth Unlock
4Passcode Unlock
7IC Card Unlock
8Fingerprint Unlock
9Wristband Unlock
12Gateway Unlock
49Hotel Card Unlock
57QR Code Unlock Success
673D Face Unlock Success
84Palm Vein Unlock Success
92Admin Passcode Unlock

Lock Events#

Actions that engage the bolt or lock the device.
recordTypeDescriptions
11Bluetooth Lock
33Fingerprint Lock
34Passcode Lock
35IC Card Lock
52App Lock
61QR Code Lock Success
693D Face Lock
86Palm Vein Lock

Security & Alarms#

Critical status codes for monitoring safety risks.
recordTypeDescriptions
29Illegal Unlock
44Anti-prying Alarm
48System Locked
64Door Unclosed Alarm
683D Face Failed (Deadbolted)
71/88Invalid/Expired Credential

System & Hardware Status#

recordTypeDescriptions
30/31Door Sensor Status
32Opened from Inside
45Auto-lock Timeout
59/60Deadbolt Status
63Auto-unlock (Passage Mode)

Special Modes#

recordTypeDescriptions
5/6Parking Lock Raise/Lower
77 - 83Dual Auth - Waiting
55Remote Control Unlock/Lock
Modified at 2026-02-10 11:20:20
Previous
Setup & Authentication
Next
KeyInfo
Built with