PartnerExportReadyEvent

Overview

The <PartnerKey>PartnerExportReadyEvent event is sent when the requested partner export data is ready for retrieval.

Event Parameters

Parameter	Data Type	Description
`BatchGuid`	UUID	The identifier for the batch associated with the event.
`PartnerKey`	string	An identifier for the partner requesting the data.
`ExportType`	string	The type of data included in the export.
`TenantId`	integer	The unique identifier for the tenant (client) for which the request is being made.
`CorrelationId`	UUID	A unique identifier for this event.
`BusinessProcessId`	UUID	The identifier for the business process associated with this event.
`TargetBusinessProcessId`	UUID	The identifier for the target business process related to this event.
`PublishedDate`	string	The date and time when the event was published, in ISO 8601 format.
`DeduplicationId`	string	A unique identifier to ensure the same event is not processed multiple times.
`EventName`	string	The name of the specific event. The `<PartnerKey>` prefix in the event name will be replaced with a partner-specific value.

Sample Event

{
    "BatchGuid": "3f1a9c2e-7b44-4d5a-9e21-6a8f0c5d1234",
    "PartnerKey": "acme-staffing",
    "EntityLookupIds": "1001,1002,1003",
    "ExportType": "Placement",
    "TenantId": 4521,
    "CorrelationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "BusinessProcessId": "a1b2c3d4-e5f6-4789-90ab-cdef01234567",
    "TargetBusinessProcessId": "b2c3d4e5-f6a7-4890-a1bc-def012345678",
    "PublishedDate": "2026-08-28090015PM",
    "DeduplicationId": "MTAwMS0xMDAyLTEwMDMtcGxhY2VtZW50",
    "EventName": "PartnerExportReadyEvent"
  }

Associated Endpoints

Use the following endpoints to request a placement export and retrieve the exported data after receiving the PartnerExportReadyEvent: Create Placement Export Request and Get Partner Export Batch Paged Data.