Partner

Registrar webhook de abertura de porta

Registra (ou atualiza) a URL que receberá notificações sempre que um acesso for liberado no dispositivo informado. Use deviceId retornado pelo endpoint GET /partner/devices.

post/api/v1/partner/webhooks

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1/partner/webhooks
  • Auth: API key in header X-API-Key

Request body

tenantSlugstring required

Slug do espaco/tenant

deviceIdstring required

ID físico do dispositivo Control iD

webhookUrlstring uri required

URL que receberá as notificações de abertura

Example request

{
  "tenantSlug": "meu-condominio",
  "deviceId": "dev-001",
  "webhookUrl": "https://beepay.com.br/webhook/abc"
}

Response

Webhook registrado com sucesso

messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.