Volunteer Webhooks - Message Definitions

Participant Added Message
This table provides a breakdown of the fields in this webhook message.

FieldData TypeNullableDescription
eventIDIntegerFalseUnique identifier of the event.
eventTypeIntegerFalseThe type of event. 1 = Employee or Community created events. 2 = Events created by Non-Profits.
recurrencIdIntegerTrueUnique recurrence identifier for this participation. NOTE: This is only applicable to Recurring Events.
occurrenceIdIntegerFalseThe occurrence identifier for this participation. An occurrence is an instance of an event.
shiftIdIntegerTrueUnique identifier for the shift that the user participated in.
hoursDecimalFalseHours tied to the participation.
charityIdIntegerTrueInternal identifier of the organization for this record. This will be Null if event was created by an NPO or Non-Profit doesn’t exist in the system
affiliateOrganizationIdIntegerTrueIn special cases, the Client Community supports custom organizations not in our system. This is the identifier for the custom organization.
organizationNameStringTrueOrganization Name.
affiliateEmployeeIdIntegerFalseUnique identifier of the employee.
employeeFirstNameStringFalseUser first name.
employeeLastNameStringFalseUser last name.
participationDateDate TimeFalseDate of the 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.
createdDateDate TimeFalseDate the record was created in the system.
affiliateIdIntegerFalseUnique identifier of the client / community.
existingParticipationBooleanFalseThis will be true if the post is an update to an existing record. False means that it is a new record in the system.
activeBooleanFalseIf False, this means that the record is no longer active in the system. i.e removed by the participant or an organizer.
guestIdIntegerTrueIndicates if this participation record is tied to an employees guest.

Event Added/Updaated Message
This table provides a breakdown of the fields in this webhook message.

FieldData TypeNullableDescription
eventIdIntegerFalseUnique identifier of the event.
nameStringFalseName of the event that was created.
startDateUtcDate TimeFalseStart date of the event created.
endDateUtcDate TimeFalseEnd date of the event created.
charityIdIntegerTrueInternal identifier of the organization for this record. This will be Null if event was created by an NPO or Non-Profit doesn’t exist in the system
affiliateOrganizationIdIntegerTrueIn special cases, the Client Community supports custom organizations not in our system. This is the identifier for the custom organization.
organizationNameStringTrueOrganization Name
eventTypeIntegerFalseThe type of event. 1 = Employee or Community created events. 2 = Events created by Non-Profits.
affiliateIdIntegerFalseUnique identifier of the client / community.
eventUpdatedBooleanFalseIf True, then the message is an update to an existing event.
EventDeletedBooleanFalseIf True, the event was deleted.