Reference
Documents and rendering, messages, exports, domains. 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.
custom_action.invoked#
A user invoked one of your custom actions.
Object: none (the event's own fields).
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b10",
"object": "event",
"type": "custom_action.invoked",
"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"
}
}
}
custom_domain.status_changed#
A custom domain for public pages changed status.
Object: custom_domain.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b11",
"object": "event",
"type": "custom_domain.status_changed",
"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": "CustomDomain",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
document_request.cancelled#
A document request was cancelled.
Object: document_request · module document_requests: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b12",
"object": "event",
"type": "document_request.cancelled",
"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": "DocumentRequest",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
document_request.created#
A document request was created.
Object: document_request · module document_requests: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b13",
"object": "event",
"type": "document_request.created",
"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": "DocumentRequest",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
document_request.fulfilled#
A document request was fulfilled.
Object: document_request · module document_requests: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b14",
"object": "event",
"type": "document_request.fulfilled",
"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": "DocumentRequest",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
document.failed#
A document could not be processed.
Object: process_document · module process_documents: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b15",
"object": "event",
"type": "document.failed",
"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": "ProcessDocument",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
document.needs_review#
A document needs a person to look at it.
Object: process_document · module process_documents: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b16",
"object": "event",
"type": "document.needs_review",
"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": "ProcessDocument",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
document.official_copy_created#
The official copy of a document was stored.
Object: none (the event's own fields).
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b17",
"object": "event",
"type": "document.official_copy_created",
"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"
}
}
}
document.processed#
A document was processed.
Object: process_document · module process_documents: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b18",
"object": "event",
"type": "document.processed",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1008",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "ProcessDocument",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
document.received#
A document was received.
Object: process_document · module process_documents: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b19",
"object": "event",
"type": "document.received",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1009",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "ProcessDocument",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
document.render_failed#
A custom template or partner render failed or timed out; FinBaze used its own layout.
Object: none (the event's own fields).
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b20",
"object": "event",
"type": "document.render_failed",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1010",
"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"
}
}
}
document.render_rejected#
A PDF the platform rendered failed the required-content checks; FinBaze used its own layout.
Object: none (the event's own fields).
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b21",
"object": "event",
"type": "document.render_rejected",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1011",
"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"
}
}
}
document.render_requested#
A document needs to be rendered by the platform. The payload has the data model and signed links to files that go with it (the invoice UBL), valid 15 minutes.
Object: none (the event's own fields).
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b22",
"object": "event",
"type": "document.render_requested",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1012",
"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"
}
}
}
export.destination_expiring#
Credentials of an export destination expire soon.
Object: export_destination · module data_export: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b23",
"object": "event",
"type": "export.destination_expiring",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1013",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "ExportDestination",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
export.failed#
A scheduled export failed.
Object: export_run · module data_export: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b24",
"object": "event",
"type": "export.failed",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1014",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "ExportRun",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
export.ready#
A scheduled export is ready.
Object: export_run · module data_export: no event is published for a company where it is hidden or off.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b25",
"object": "event",
"type": "export.ready",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1015",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "ExportRun",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
message.created#
A message needs to be delivered by the platform.
Object: none (the event's own fields).
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b26",
"object": "event",
"type": "message.created",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1016",
"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"
}
}
}
message.unacknowledged#
A delivered message was not acknowledged in time.
Object: none (the event's own fields).
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b27",
"object": "event",
"type": "message.unacknowledged",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1017",
"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"
}
}
}