Field Projections

Field projections allow clients to select exactly which fields they want to receive in their webhook payloads for a specific event of a particular webhook. If no field projections are applied, all available fields are returned. Below is an example of the trainingArchived object that would currently be sent to the client endpoint:

"trainingArchived": {
  "data": {
    "targetUserId": 9999,
    "targetUserRef": "UserRef9999",
    "targetUserFirstName": "MyFirstName",
    "targetUserLastName": "MyLastName",
    "targetUsername": "UserName",
    "targetUserDivisionRef": "MyDivision",
    "targetUserLocationRef": "MyLocation",
    "createdByUserId": 10000,
    "createdByUserRef": "UserRef10000",
    "trainingId": "370e574a-f21a-4d56-beea-1ddceae16743",
    "trainingRef": "370E574A-F21A-4D56-BEEA-1DDCEAE16743",
    "trainingTitle": "TestVideoCourse",
    "providerId": "20abcfb3-45d9-4882-a50a-90904fb6ffa6",
    "eventId": "e1085249-d545-4e25-a354-7f89656bff39",
    "trainingActionDateTimestamp": "2025-05-30T21:39:37.7330000Z",
    "targetUserGuid": "0b272e56-e459-4b72-9351-d1e032066aaf",
    "trainingRegistrationNumber": 2,
    "isStandaloneOnTranscript": true,
    "transcriptUrl": "https://yourClientPortal.csod.com/phnx/driver.aspx?routename=Social/UniversalProfile/Transcript&TargetUser=9999"
  }
}

To customize the payload, you can apply a field projection on the webhook event. This is done by editing the webhook and navigating to the event section. Under Events, a new section labeled Configure Payloads will be available. There, you can edit the projection for a specific event by selecting or deselecting desired fields.

This process removes unselected fields from the payload, ensuring that only explicitly chosen fields are included. After applying the projection, the trainingArchived payload might look like this:

"trainingArchived": {
  "data": {
    "targetUserId": 9999,
    "targetUserFirstName": "MyFirstName",
    "targetUserLastName": "MyLastName",
    "targetUsername": "UserName",
    "targetUserDivisionRef": "MyDivision",
    "createdByUserId": 10000,
    "trainingId": "370e574a-f21a-4d56-beea-1ddceae16743",
    "trainingTitle": "TestVideoCourse",
    "trainingActionDateTimestamp": "2025-05-30T21:39:37.7330000Z"
  }
}

Field projections are currently supported for employee and training webhooks.