Event related

Volunteer registered for a Shift

Triggered whenever a User registers for a Shift through the app.

The Volunteer can either register alone, "Group of 1", or as a member of a Group.

Response Format

Returns a JSON object of the registration data.

Field	Type	Required	Description	Format Allowed
kindlyUserId	String	✔	User's ID.	Any string value
kindlyShiftId	String	✔	Shift's ID.	Any string value
kindlyPartnerGroupId	String	❌	Group's ID.	Any string value

Example Response Body

{
  "kindlyUserId": "10473963d373401fa1430096bfb38da7",
  "kindlyShiftId": "e0b4a43800a24116ad269608ec0178d7",
  "kindlyPartnerGroupId": "d223d859edae404290fc6d79a393aa24"
}

---

Volunteer unregistered from a Shift

Triggered whenever a User unregisters from a Shift through the app.

Response Format

Returns a JSON object of the unregistration data.

Field	Type	Required	Description	Format Allowed
kindlyUserId	String	✔	User's ID.	Any string value
kindlyShiftId	String	✔	Shift's ID.	Any string value

Example Response Body

{
  "kindlyUserId": "10473963d373401fa1430096bfb38da7",
  "kindlyShiftId": "e0b4a43800a24116ad269608ec0178d7"
}

---

Volunteer checked in on a Shift

Triggered whenever a User checks in for a Shift through the app.

The check in should occur once the User arrives at the Event's location.

If the User registers for the Shift with at least 30 minutes of the Shift start time, this webhook is triggered when the User registers for the Shift through the app.

Response Format

Returns a JSON object of the unregistration data.

Field	Type	Required	Description	Format Allowed
kindlyUserId	String	✔	User's ID.	Any string value
kindlyShiftId	String	✔	Shift's ID.	Any string value

Example Response Body

{
  "kindlyUserId": "10473963d373401fa1430096bfb38da7",
  "kindlyShiftId": "e0b4a43800a24116ad269608ec0178d7"
}