FinBaze for Platforms

Reference

Support requests, escalations and consented access. Samples show the envelope; data.object of an event that has a snapshot carries the object's fields as of the event (shown here with its type and id). See the envelope.

support.access_expired#

A support grant reached its end.

Object: support_access_grant.

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b10",
  "object": "event",
  "type": "support.access_expired",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1000",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "reason": "example",
      "scope": "read",
      "status": "requested",
      "durationMinutes": 1,
      "requestedAt": "2026-03-02T10:00:00.000Z",
      "activatedAt": "2026-03-02T10:00:00.000Z",
      "expiresAt": "2026-03-02T10:00:00.000Z",
      "escalationId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "breakGlass": false,
      "requestedBy": "finbaze_support"
    }
  }
}

support.access_granted#

A support access request was approved; FinBaze support can view the company until expiresAt.

Object: support_access_grant.

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b11",
  "object": "event",
  "type": "support.access_granted",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1001",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "reason": "example",
      "scope": "read",
      "status": "requested",
      "durationMinutes": 1,
      "requestedAt": "2026-03-02T10:00:00.000Z",
      "activatedAt": "2026-03-02T10:00:00.000Z",
      "expiresAt": "2026-03-02T10:00:00.000Z",
      "escalationId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "breakGlass": false,
      "requestedBy": "finbaze_support",
      "decidedVia": "embed"
    }
  }
}

support.access_requested#

FinBaze support asked to view a company. The company admin decides.

Object: support_access_grant.

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b12",
  "object": "event",
  "type": "support.access_requested",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1002",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "reason": "example",
      "scope": "read",
      "status": "requested",
      "durationMinutes": 1,
      "requestedAt": "2026-03-02T10:00:00.000Z",
      "activatedAt": "2026-03-02T10:00:00.000Z",
      "expiresAt": "2026-03-02T10:00:00.000Z",
      "escalationId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "breakGlass": false,
      "requestedBy": "finbaze_support"
    }
  }
}

support.access_revoked#

A live support grant was ended early.

Object: support_access_grant.

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b13",
  "object": "event",
  "type": "support.access_revoked",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1003",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "reason": "example",
      "scope": "read",
      "status": "requested",
      "durationMinutes": 1,
      "requestedAt": "2026-03-02T10:00:00.000Z",
      "activatedAt": "2026-03-02T10:00:00.000Z",
      "expiresAt": "2026-03-02T10:00:00.000Z",
      "escalationId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "breakGlass": false,
      "requestedBy": "finbaze_support",
      "revokedAt": "2026-03-02T10:00:00.000Z",
      "revokedBy": "company"
    }
  }
}

support.break_glass#

FinBaze opened a company without consent (two admins, read only, at most two hours).

Object: support_access_grant.

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b14",
  "object": "event",
  "type": "support.break_glass",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1004",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "reason": "example",
      "scope": "read",
      "status": "requested",
      "durationMinutes": 1,
      "requestedAt": "2026-03-02T10:00:00.000Z",
      "activatedAt": "2026-03-02T10:00:00.000Z",
      "expiresAt": "2026-03-02T10:00:00.000Z",
      "escalationId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "breakGlass": true,
      "requestedBy": "finbaze_support",
      "twoAdminApproval": true
    }
  }
}

support.escalation.created#

An escalation to FinBaze support was created.

Object: support_escalation.

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b15",
  "object": "event",
  "type": "support.escalation.created",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1005",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "subject": "example",
      "severity": "low",
      "status": "open",
      "source": "platform",
      "requestIds": [
        "example"
      ],
      "screen": "example",
      "created": "2026-03-02T10:00:00.000Z",
      "updated": "2026-03-02T10:00:00.000Z"
    }
  }
}

support.escalation.updated#

An escalation changed status or severity, or got a comment.

Object: support_escalation.

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b16",
  "object": "event",
  "type": "support.escalation.updated",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1006",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "subject": "example",
      "severity": "low",
      "status": "open",
      "source": "platform",
      "requestIds": [
        "example"
      ],
      "screen": "example",
      "created": "2026-03-02T10:00:00.000Z",
      "updated": "2026-03-02T10:00:00.000Z",
      "change": "status",
      "commentId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "commentAuthor": "platform"
    }
  }
}

support.requested#

A company user asked for help in contact-support and the platform handles support (partner_first).

Object: support_request.

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b17",
  "object": "event",
  "type": "support.requested",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1007",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
      "screen": "example",
      "requestIds": [
        "example"
      ],
      "componentVersion": "example",
      "userId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
    }
  }
}