Events

This page describes the event types delivered through EDS V2. Each event arrives in an EVENT frame — see Protocol for the envelope format.

---

TENANT_ONBOARDED

Emitted when a tenant is successfully subscribed to your integration.

Example EVENT Frame

{
  "frameType": "EVENT",
  "framePayload": {
    "eventId": "a1b2c3d4-0000-0000-0000-000000000001",
    "eventType": "TENANT_ONBOARDED",
    "receiptId": "f9e8d7c6-0000-0000-0000-000000000002",
    "eventTs": "2026-03-20T14:30:00.000Z",
    "queueName": "my-integration-queue",
    "eventPayload": {
      "tenantId": "P0001",
      "empegoTenantId": "tenant-abc"
    }
  }
}

---

TENANT_OFFBOARDED

Emitted when a tenant is unsubscribed from your integration.

Example EVENT Frame

{
  "frameType": "EVENT",
  "framePayload": {
    "eventId": "b2c3d4e5-0000-0000-0000-000000000003",
    "eventType": "TENANT_OFFBOARDED",
    "receiptId": "e8d7c6b5-0000-0000-0000-000000000004",
    "eventTs": "2026-03-20T15:00:00.000Z",
    "queueName": "my-integration-queue",
    "eventPayload": {
      "tenantId": "P0001",
      "empegoTenantId": "tenant-abc"
    }
  }
}