Volunteer webhooks - message definitions

The following is a description of the webhook fields in the Participant was added message.

Field Data type Nullable Description
eventID Integer False Unique identifier of the event
eventType Integer False

The type of event

1 = Employee or community-created events

2 = Events created by nonprofits
recurrencId Integer True

Unique recurrence identifier for this participation

NOTE: This is only applicable to recurring events.
occurrenceId Integer False

The occurrence identifier for this participation

An occurrence is an instance of an event.
shiftId Integer True Unique identifier for the shift that the user participated in
hours Decimal False Hours tied to the participation
charityId Integer True

Internal identifier of the organization for this record

This will be null if event was created by an NPO or the nonprofit doesn’t exist in the system.
affiliateOrganizationId Integer True In special cases, the Client Community supports custom organizations not in our system. This is the identifier for the custom organization.
organizationName String True Organization name
affiliateEmployeeId Integer False Unique employee identifier
employeeFirstName String False Employee's first name
employeeLastName String False Employee's last name
participationDate Date Time False

Date of participation

NOTE: If the shift has not started and is in the future, this date will be the shift start date. If the shift has already started and spans multiple days, this will be the date the user added the shift.
createdDate Date Time False Date the record was created in the system
affiliateId Integer False This will be true if the post is an update to an existing record. False means that it is a new record in the system.
existingParticipation Boolean False This will be true if the post is an update to an existing record. False means that it is a new record in the system.
active Boolean False If false, the record is no longer active in the system, that is, it was removed by the participant or an organizer.
guestId Integer True Indicates whether this participation record is tied to an employee's guest

The following is a description of the webhook fields in the Event was added/updated message.

Field Data Type Nullable Description
eventId Integer False Unique identifier of the event
name String False Name of the event that was created
startDateUtc Date Time False Start date of the event created
endDateUtc Date Time False End date of the event created
charityId Integer True

Internal identifier of the organization for this record

This will be null if event was created by an NPO or the nonprofit doesn’t exist in the system.
affiliateOrganizationId Integer True In special cases, the Client Community supports custom organizations not in our system. This is the identifier for the custom organization.
organizationName String True Organization name
eventType Integer False

The type of event

1 = Employee or community-created events

2 = Events created by nonprofits
affiliateId Integer False Unique identifier of the client / community
eventUpdated Boolean False If true, the message is an update to an existing event.
eventDeleted Boolean False If true, the event was deleted.