Volunteer Webhooks - Message Definitions

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 Non-Profits.

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 Non-Profit 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 identifier of the employee.

employeeFirstName

String

False

User first name.

employeeLastName

String

False

User last name.

participationDate

Date Time

False

Date 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.

createdDate

Date Time

False

Date the record was created in the system.

affiliateId

Integer

False

Unique identifier of the client / community.

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, this means that the record is no longer active in the system. i.e removed by the participant or an organizer.

guestId

Integer

True

Indicates if this participation record is tied to an employees guest.

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 Non-Profit 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 Non-Profits.

affiliateId

Integer

False

Unique identifier of the client / community.

eventUpdated

Boolean

False

If True, then the message is an update to an existing event.

EventDeleted

Boolean

False

If True, the event was deleted.