passes.permits.expiring

POST

/passes.permits.expiring

[E-01] Permit expiring (early warning)

Emitted once per threshold at 7, 3, and 1 day(s) before validTill for ACCEPTED permits. Idempotent per threshold.

Delivered as an HTTP POST to every destination URL configured for passes.permits.expiring (Dashboard → Settings → API → Webhooks). Headers: X-Buzzin-Event: passes.permits.expiring, X-Buzzin-Delivery: <id>, and X-Buzzin-Token: <secret> when the endpoint has a secret. Respond 2xx to acknowledge.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200OK

Your endpoint acknowledges receipt (any 2xx).

This response does not have a body.

Request Example

Shell

JavaScript

Java

Swift

curl --location '/passes.permits.expiring' \
--header 'Content-Type: application/json' \
--data '{
    "id": "66ffaa00bb11cc22dd33ee44",
    "event": "passes.permits.expiring",
    "communityId": "6840270a99ca91002185fcd6",
    "createdAt": "2026-06-29T10:15:00.000Z",
    "data": {
        "permitId": "66f0a1b2c3d4e5f600000abc",
        "passNumber": "WP-002391",
        "status": 1,
        "statusName": "ACCEPTED",
        "type": "permits",
        "permitType": "buildUp",
        "communityId": "6840270a99ca91002185fcd6",
        "propertyId": "66e0000000000000000000a1",
        "flatId": "66e0000000000000000000b2",
        "communityContractorId": "66f0a1b2c3d4e5f600000001",
        "salesforceId": "a1B5g000000XYZWEAW",
        "validFrom": "2026-07-01T06:00:00.000Z",
        "validTill": "2026-07-31T18:00:00.000Z",
        "accessCode": "7H2KQ9ZTM4XB1RPA8VC0DLEN",
        "permitDocumentationUrl": "string",
        "daysUntilExpiry": 7
    }
}'

passes.permits.updated

passes.permits.expired