For managers, plan shift schedules, broadcast open and unfilled shifts to your team. For team members, easily view your shifts and make schedule-change requests (swap/offer/time off).
Status: Preview |
Tier: Standard |
Version: 1.0 |
Name |
Summary |
List teams |
|
Get a Schedule's details |
|
List all Time Off instances |
|
Get a Time Off instance |
|
Delete a Time Off instance |
|
List all Shifts |
|
Get a Shift |
|
Delete a Shift |
|
List all Open Shifts |
|
CreateOpenShift (string teamId, EditOpenShiftRequest request) |
Create a new Open Shift |
Get an Open Shift |
|
UpdateOpenShift (string teamId, string openShiftId, EditOpenShiftRequest request) |
Update an Open Shift |
Delete an Open Shift |
|
ListTimeOffReasons (string teamId, [advanced][Optional]integer $top) |
List all Time Off Reasons |
ListSchedulingGroups (string teamId, [advanced][Optional]integer $top) |
List all Scheduling Groups |
GetSchedulingGroup (string teamId, string schedulingGroupId) |
Get a Scheduling Group |
List all Time Off requests |
|
GetTimeOffShiftRequest (string teamId, string timeOffRequestId) |
Get a Time Off request |
Approve a Time Off request |
|
Decline a Time Off request |
|
List all Offer Shift requests |
|
GetOfferShiftRequest (string teamId, string offerShiftRequestId) |
Get an Offer Shift request |
Approve an Offer Shift request |
|
Decline an Offer Shift request |
|
List all Swap Shifts requests |
|
GetSwapShiftsChangeRequest (string teamId, string swapShiftsChangeRequestId) |
Get a Swap Shifts request |
Approve a Swap Shifts request |
|
Decline a Swap Shifts request |
|
List all Open Shift requests |
|
GetOpenShiftChangeRequest (string teamId, string openShiftChangeRequestId) |
Get an Open Shift request |
Approve an Open Shift request |
|
Decline an Open Shift request |
|
Delete WebHook Subscription |
|
Update subscription |
|
Proxy endpoint to validate subscriptions and forward notifications |
Name |
Summary |
TriggerForOpenShiftChangeRequests (string teamId, WebHookRequest request) |
When an Open Shift request is created, updated or deleted |
TriggerForSwapShiftsChangeRequests (string teamId, WebHookRequest request) |
When a Swap Shifts request is created, updated or deleted |
TriggerForOfferShiftRequests (string teamId, WebHookRequest request) |
When an Offer Shift request is created, updated or deleted |
TriggerForTimeOffRequests (string teamId, WebHookRequest request) |
When a Time Off request is created, updated or deleted |
When a Shift is created, updated or deleted |
Name |
Summary |
Draft Changes > |
|
Draft Changes > |
|
Draft Changes > |
|
|
|
|
|
List of Time Off Reasons associated with a team |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Offer Shift Request |
|
|
|
|
|
|
|
|
|
Open Shift Change Request |
|
Open Shift |
|
|
|
|
|
Scheduling Group |
|
|
|
|
|
|
|
Shift |
|
|
|
|
|
|
|
|
|
Swap Shift Request |
|
|
|
|
|
|
|
|
|
Time Off Request |
|
Time Off |
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List teams
Description: This operation retrieves a list of all the Teams (Office 365 Groups) you are a member of.
Syntax:
ShiftsforMicrosoftTeams.GetAllTeams ()
Returns:
Type:GetAllTeamsResponse
Summary: Get a Schedule's details
Description: This operation returns details of a Schedule using the Schedule's unique ID.
Syntax:
ShiftsforMicrosoftTeams.GetSchedule (string teamId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
Returns:
Type:ScheduleResponse
Description: Schedule Entity.
Summary: List all Time Off instances
Description: This operation returns all Time Off instances in a Schedule
Syntax:
ShiftsforMicrosoftTeams.ListTimesOff (string teamId, [advanced][Optional]string startTime, [advanced][Optional]string endTime, [advanced][Optional]integer $top)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
startTime |
string(date-time) (From Start Time) |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
False |
|
endTime |
string(date-time) (To End Time) |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
False |
|
$top |
integer(int32) (Page Size) |
Items per page (enable Pagination under .../Settings) |
False |
Returns:
Type:ListTimesOffResponse
Summary: Get a Time Off instance
Description: This operation returns details for a Time Off using its unique ID.
Syntax:
ShiftsforMicrosoftTeams.GetTimeOff (string teamId, string timeOffId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
timeOffId |
string (Time Off ID) |
The unique ID of the Time Off. |
True |
Returns:
Type:TimeOffResponse
Summary: Time Off
Description: Time Off Entity.
Summary: Delete a Time Off instance
Description: This operation deletes a Time Off using its unique ID.
Syntax:
ShiftsforMicrosoftTeams.DeleteTimeOff (string teamId, string timeOffId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
timeOffId |
string (Time Off ID) |
The unique ID of the Time Off. |
True |
Returns:
Summary: List all Shifts
Description: This operation returns all Shifts assigned to members of a team
Syntax:
ShiftsforMicrosoftTeams.ListShifts (string teamId, [advanced][Optional]string startTime, [advanced][Optional]string endTime, [advanced][Optional]integer $top)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
startTime |
string(date-time) (From Start Time) |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
False |
|
endTime |
string(date-time) (To End Time) |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
False |
|
$top |
integer(int32) (Page Size) |
Items per page (enable Pagination under .../Settings) |
False |
Returns:
Type:ListShiftsResponse
Summary: Get a Shift
Description: This operation returns details for a Shift using the Shift's unique ID.
Syntax:
ShiftsforMicrosoftTeams.GetShift (string teamId, string shiftId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
shiftId |
string (Shift ID) |
The unique ID of the Shift. |
True |
Returns:
Type:ShiftResponse
Summary: Shift
Description: Shift Entity.
Summary: Delete a Shift
Description: This operation deletes a Shift using the Shift's unique ID.
Syntax:
ShiftsforMicrosoftTeams.DeleteShift (string teamId, string shiftId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
shiftId |
string (Shift ID) |
The unique ID of the Shift. |
True |
Returns:
Summary: List all Open Shifts
Description: This operation returns all Open Shifts in a team.
Syntax:
ShiftsforMicrosoftTeams.ListOpenShifts (string teamId, [advanced][Optional]string startTime, [advanced][Optional]string endTime, [advanced][Optional]integer $top)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
startTime |
string(date-time) (From Start Time) |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
False |
|
endTime |
string(date-time) (To End Time) |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
False |
|
$top |
integer(int32) (Page Size) |
Items per page (enable Pagination under .../Settings) |
False |
Returns:
Summary: Create a new Open Shift
Description: Create a new Open Shift in a Schedule.
Syntax:
ShiftsforMicrosoftTeams.CreateOpenShift (string teamId, EditOpenShiftRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
request |
|
|
True |
Returns:
Type:OpenShiftResponse
Summary: Open Shift
Description: Open Shift Entity
Summary: Get an Open Shift
Description: This operation returns details for an Open Shift.
Syntax:
ShiftsforMicrosoftTeams.GetOpenShift (string teamId, string openShiftId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
openShiftId |
string (Open Shift ID) |
The unique ID of the Open Shift. |
True |
Returns:
Type:OpenShiftResponse
Summary: Open Shift
Description: Open Shift Entity
Summary: Update an Open Shift
Description: Update an Open Shift in a Schedule.
Syntax:
ShiftsforMicrosoftTeams.UpdateOpenShift (string teamId, string openShiftId, EditOpenShiftRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
openShiftId |
string (Open Shift ID) |
The unique ID of the Open Shift. |
True |
|
request |
|
|
True |
Returns:
Type:OpenShiftResponse
Summary: Open Shift
Description: Open Shift Entity
Summary: Delete an Open Shift
Description: This operation deletes an Open Shift.
Syntax:
ShiftsforMicrosoftTeams.DeleteOpenShift (string teamId, string openShiftId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
openShiftId |
string (Open Shift ID) |
The unique ID of the Open Shift. |
True |
Returns:
Summary: List all Time Off Reasons
Description: This operation returns the list of Time Off Reasons associated with a team.
Syntax:
ShiftsforMicrosoftTeams.ListTimeOffReasons (string teamId, [advanced][Optional]integer $top)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
$top |
integer(int32) (Page Size) |
Items per page (enable Pagination under .../Settings) |
False |
Returns:
Type:GetTimeOffReasonsResponse
Summary: List of Time Off Reasons associated with a team
Description: The list of Time Off Reasons.
Summary: List all Scheduling Groups
Description: This operation returns all Scheduling Groups in a Schedule.
Syntax:
ShiftsforMicrosoftTeams.ListSchedulingGroups (string teamId, [advanced][Optional]integer $top)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
$top |
integer(int32) (Page Size) |
Items per page (enable Pagination under .../Settings) |
False |
Returns:
Type:ListSchedulingGroupsResponse
Summary: Get a Scheduling Group
Description: This operation returns details for a Scheduling Group using its unique ID.
Syntax:
ShiftsforMicrosoftTeams.GetSchedulingGroup (string teamId, string schedulingGroupId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
schedulingGroupId |
string (Scheduling Group ID) |
The unique ID of the Scheduling Group. |
True |
Returns:
Summary: Scheduling Group
Description: Scheduling Group Entity
Summary: List all Time Off requests
Description: This operation returns all Time Off requests in a Schedule.
Syntax:
ShiftsforMicrosoftTeams.ListTimeOffRequests (string teamId, [advanced][Optional]integer $top, [advanced][Optional]string state)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
$top |
integer(int32) (Page Size) |
Items per page (enable Pagination under .../Settings) |
False |
|
state |
string (Request State)Values: [pending, approved, declined] |
Request state filter |
False |
Returns:
Type:ListTimeOffRequestsResponse
Summary: Get a Time Off request
Description: This operation returns a Time Off request by ID.
Syntax:
ShiftsforMicrosoftTeams.GetTimeOffShiftRequest (string teamId, string timeOffRequestId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
timeOffRequestId |
string (Time Off Request ID) |
The unique ID of the Time Off request |
True |
Returns:
Summary: Time Off Request
Description: Time Off Request Entity
Summary: Approve a Time Off request
Description: This operation allows managers to approve a Time Off request.
Syntax:
ShiftsforMicrosoftTeams.TimeOffRequestApprove (string teamId, string timeOffRequestId, TimeOffRequestApproveParameterRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
timeOffRequestId |
string (Time Off Request ID) |
The unique ID of the Time Off request |
True |
|
request |
TimeOffRequestApproveParameterRequest
|
Manager approves a Time Off request. |
True |
Returns:
Type:TimeOffRequestApproveResponse
Summary: Decline a Time Off request
Description: This operation allows managers to decline a Time Off request.
Syntax:
ShiftsforMicrosoftTeams.TimeOffRequestDecline (string teamId, string timeOffRequestId, TimeOffRequestDeclineParameterRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
timeOffRequestId |
string (Time Off Request ID) |
The unique ID of the Time Off request |
True |
|
request |
TimeOffRequestDeclineParameterRequest
|
Manager declines a Time Off request. |
True |
Returns:
Type:TimeOffRequestDeclineResponse
Summary: List all Offer Shift requests
Description: This operation returns all Offer Shift requests in a Schedule.
Syntax:
ShiftsforMicrosoftTeams.ListOfferShiftRequests (string teamId, [advanced][Optional]integer $top, [advanced][Optional]string state)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
$top |
integer(int32) (Page Size) |
Items per page (enable Pagination under .../Settings) |
False |
|
state |
string (Request State)Values: [pending, approved, declined] |
Request state filter |
False |
Returns:
Type:ListOfferShiftRequestsResponse
Summary: Get an Offer Shift request
Description: This operation returns an Offer Shift request by ID.
Syntax:
ShiftsforMicrosoftTeams.GetOfferShiftRequest (string teamId, string offerShiftRequestId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
offerShiftRequestId |
string (Offer Shift Request ID) |
The unique ID of the Offer Shift request |
True |
Returns:
Type:OfferShiftRequestResponse
Summary: Offer Shift Request
Description: Offer Shift Request Entity
Summary: Approve an Offer Shift request
Description: This operation allows recipients/managers to approve an Offer Shift request.
Syntax:
ShiftsforMicrosoftTeams.OfferShiftRequestApprove (string teamId, string offerShiftRequestId, OfferShiftRequestApproveParameterRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
offerShiftRequestId |
string (Offer Shift Request ID) |
The unique ID of the Offer Shift request |
True |
|
request |
OfferShiftRequestApproveParameterRequest
|
Approve an Offer Shift request. |
True |
Returns:
Type:OfferShiftRequestApproveResponse
Summary: Decline an Offer Shift request
Description: This operation allows users to decline an Offer Shift request.
Syntax:
ShiftsforMicrosoftTeams.OfferShiftRequestDecline (string teamId, string offerShiftRequestId, OfferShiftRequestDeclineParameterRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
offerShiftRequestId |
string (Offer Shift Request ID) |
The unique ID of the Offer Shift request |
True |
|
request |
OfferShiftRequestDeclineParameterRequest
|
Recipient/Manager declines an Offer Shift request. |
True |
Returns:
Type:OfferShiftRequestDeclineResponse
Summary: List all Swap Shifts requests
Description: This operation returns all Swap Shifts requests in a Schedule.
Syntax:
ShiftsforMicrosoftTeams.ListSwapShiftsChangeRequests (string teamId, [advanced][Optional]integer $top, [advanced][Optional]string state)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
$top |
integer(int32) (Page Size) |
Items per page (enable Pagination under .../Settings) |
False |
|
state |
string (Request State)Values: [pending, approved, declined] |
Request state filter |
False |
Returns:
Type:ListSwapShiftsChangeRequestsResponse
Summary: Get a Swap Shifts request
Description: This operation returns a Swap Shifts request by ID.
Syntax:
ShiftsforMicrosoftTeams.GetSwapShiftsChangeRequest (string teamId, string swapShiftsChangeRequestId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
swapShiftsChangeRequestId |
string (Swap Shifts Change Request ID) |
The unique ID of the request |
True |
Returns:
Type:SwapShiftsChangeRequestResponse
Summary: Swap Shift Request
Description: Swap Shift Request Entity
Summary: Approve a Swap Shifts request
Description: This operation allows a user to approve a Swap Shifts request.
Syntax:
ShiftsforMicrosoftTeams.SwapShiftsChangeRequestApprove (string teamId, string swapShiftsChangeRequestId, SwapShiftsChangeRequestApproveParameterRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
swapShiftsChangeRequestId |
string (Swap Shifts Change Request ID) |
The unique ID of the request |
True |
|
request |
SwapShiftsChangeRequestApproveParameterRequest
|
Approve a Swap Shifts change request. |
True |
Returns:
Type:SwapShiftsChangeRequestApproveResponse
Summary: Decline a Swap Shifts request
Description: This operation allows users to decline a Swap Shifts request.
Syntax:
ShiftsforMicrosoftTeams.SwapShiftsChangeRequestDecline (string teamId, string swapShiftsChangeRequestId, SwapShiftsChangeRequestDeclineParameterRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
swapShiftsChangeRequestId |
string (Swap Shifts Change Request ID) |
The unique ID of the request |
True |
|
request |
SwapShiftsChangeRequestDeclineParameterRequest
|
Decline a Swap Shifts change request. |
True |
Returns:
Type:SwapShiftsChangeRequestDeclineResponse
Summary: List all Open Shift requests
Description: This operation returns all Open Shift change requests in a Schedule.
Syntax:
ShiftsforMicrosoftTeams.ListOpenShiftChangeRequests (string teamId, [advanced][Optional]integer $top, [advanced][Optional]string state)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
$top |
integer(int32) (Page Size) |
Items per page (enable Pagination under .../Settings) |
False |
|
state |
string (Request State)Values: [pending, approved, declined] |
Request state filter |
False |
Returns:
Type:ListOpenShiftChangeRequestsResponse
Summary: Get an Open Shift request
Description: This operation returns an Open Shift change request by ID.
Syntax:
ShiftsforMicrosoftTeams.GetOpenShiftChangeRequest (string teamId, string openShiftChangeRequestId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
openShiftChangeRequestId |
string (Open Shift Change Request ID) |
The unique ID of the request |
True |
Returns:
Type:OpenShiftChangeRequestResponse
Summary: Open Shift Change Request
Description: Open Shift Change Request Entity
Summary: Approve an Open Shift request
Description: This operation allows managers to approve an Open Shift request.
Syntax:
ShiftsforMicrosoftTeams.OpenShiftChangeRequestApprove (string teamId, string openShiftChangeRequestId, OpenShiftChangeRequestApproveParameterRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
openShiftChangeRequestId |
string (Open Shift Change Request ID) |
The unique ID of the request |
True |
|
request |
OpenShiftChangeRequestApproveParameterRequest
|
Manager approves an Open Shift change request. |
True |
Returns:
Type:OpenShiftChangeRequestApproveResponse
Summary: Decline an Open Shift request
Description: This operation allows managers to decline an Open Shift request.
Syntax:
ShiftsforMicrosoftTeams.OpenShiftChangeRequestDecline (string teamId, string openShiftChangeRequestId, OpenShiftChangeRequestDeclineParameterRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
openShiftChangeRequestId |
string (Open Shift Change Request ID) |
The unique ID of the request |
True |
|
request |
OpenShiftChangeRequestDeclineParameterRequest
|
Manager declines an Open Shift change request. |
True |
Returns:
Type:OpenShiftChangeRequestDeclineResponse
Summary: Delete WebHook Subscription
Description: Delete WebHook Subscription
Syntax:
ShiftsforMicrosoftTeams.DeleteWebHookSubscription (string subscriptionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionId |
string
|
|
True |
Returns:
Summary: Update subscription
Description: Renew a Microsoft Graph webhook subscription by updating its expiration time.
Syntax:
ShiftsforMicrosoftTeams.RenewWebHookSubscription (string subscriptionId, [Optional]RenewWebHookSubscriptionParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionId |
string
|
|
True |
|
body |
RenewWebHookSubscriptionParameterBody
|
|
False |
Returns:
Summary: Proxy endpoint to validate subscriptions and forward notifications
Description: Proxy endpoint that receives notifications from the GraphAPI and validates subscriptions.
Syntax:
ShiftsforMicrosoftTeams.WebhookResponse ()
Returns:
Summary: When an Open Shift request is created, updated or deleted
Description: This operation triggers when an Open Shift request is created, updated or deleted.
Syntax:
ShiftsforMicrosoftTeams.TriggerForOpenShiftChangeRequests (string teamId, WebHookRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
request |
|
|
True |
Returns:
Type:TriggerForOpenShiftChangeRequestsResponse
Summary: When a Swap Shifts request is created, updated or deleted
Description: This operation triggers when a Swap Shifts request is created, updated or deleted.
Syntax:
ShiftsforMicrosoftTeams.TriggerForSwapShiftsChangeRequests (string teamId, WebHookRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
request |
|
|
True |
Returns:
Type:TriggerForSwapShiftsChangeRequestsResponse
Summary: When an Offer Shift request is created, updated or deleted
Description: This operation triggers when an Offer Shift request is created, updated or deleted.
Syntax:
ShiftsforMicrosoftTeams.TriggerForOfferShiftRequests (string teamId, WebHookRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
request |
|
|
True |
Returns:
Type:TriggerForOfferShiftRequestsResponse
Summary: When a Time Off request is created, updated or deleted
Description: This operation triggers when a Time Off request is created, updated or deleted.
Syntax:
ShiftsforMicrosoftTeams.TriggerForTimeOffRequests (string teamId, WebHookRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
request |
|
|
True |
Returns:
Type:TriggerForTimeOffRequestsResponse
Summary: When a Shift is created, updated or deleted
Description: This operation triggers when a Shift is created, updated or deleted.
Syntax:
ShiftsforMicrosoftTeams.TriggerForShifts (string teamId, WebHookRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
teamId |
string (Team) |
Add Team ID |
True |
|
request |
|
|
True |
Returns:
Summary: Draft Changes >
Description: Preliminary version of the Open Shift
Properties:
Name |
Type |
Summary |
displayName |
string Display Name |
Display Name |
notes |
string Notes |
Notes |
startDateTime |
string(date-time) Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
endDateTime |
string(date-time) End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
theme |
string Theme |
Theme color. Values: [white, blue, green, purple, pink, yellow, gray, darkblue, darkgreen, darkpurple, darkpink, darkyellow] |
openSlotCount |
integer Open Slot Count |
Open Slot Count |
activities |
array of (ActivitiesItem) Activities |
Shift activities |
Summary: Activity
Description: Shift activity
Properties:
Name |
Type |
Summary |
isPaid |
boolean Is Paid |
Is Paid |
startDateTime |
string(date-time) Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
endDateTime |
string(date-time) End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
code |
string Code |
Code |
displayName |
string Display Name |
Display Name |
Summary: Draft Changes >
Description: Preliminary version of the Shift
Properties:
Name |
Type |
Summary |
displayName |
string Display Name |
Display Name |
notes |
string Notes |
Notes |
startDateTime |
string(date-time) Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
endDateTime |
string(date-time) End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
theme |
string Theme |
Theme color. Values: [white, blue, green, purple, pink, yellow, gray, darkblue, darkgreen, darkpurple, darkpink, darkyellow] |
activities |
array of (ActivitiesItem) Activities |
Shift activities |
Summary: Activity
Description: Shift activity
Properties:
Name |
Type |
Summary |
isPaid |
boolean Is Paid |
Is Paid |
startDateTime |
string(date-time) Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
endDateTime |
string(date-time) End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
code |
string Code |
Code |
displayName |
string Display Name |
Display Name |
Summary: Draft Changes >
Description: Preliminary version of the Time Off
Properties:
Name |
Type |
Summary |
timeOffReasonId |
string Time Off Reason ID |
Time Off Reason ID. |
startDateTime |
string(date-time) Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
endDateTime |
string(date-time) End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
theme |
string Theme |
Theme color. Values: [white, blue, green, purple, pink, yellow, gray, darkblue, darkgreen, darkpurple, darkpink, darkyellow] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
schedulingGroupId |
string Scheduling Group ID |
Scheduling Group ID |
sharedOpenShift |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
displayName |
string Display Name |
Display Name |
notes |
string Notes |
Notes |
startDateTime |
string(date-time) Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
endDateTime |
string(date-time) End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
theme |
string Theme |
Theme color. Values: [white, blue, green, purple, pink, yellow, gray, darkblue, darkgreen, darkpurple, darkpink, darkyellow] |
openSlotCount |
integer Open Slot Count |
Open Slot Count |
activities |
array of (ActivitiesItem) Activities |
Shift activities |
Summary: Activity
Description: Shift activity
Properties:
Name |
Type |
Summary |
isPaid |
boolean Is Paid |
Is Paid |
startDateTime |
string(date-time) Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
endDateTime |
string(date-time) End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
code |
string Code |
Code |
displayName |
string Display Name |
Display Name |
Summary:
Description:
Properties:
Name |
Type |
Summary |
@odata.context |
string
|
|
value |
array of (ValueItem) Teams List |
List of one or more Teams you are a part of. |
Summary: Team
Description: Team Entity
Properties:
Name |
Type |
Summary |
description |
string Description |
More information about the Team. |
displayName |
string Name |
Brief summary of the Team. |
id |
string Id |
Unique ID of the Team (O365 group). |
Summary: List of Time Off Reasons associated with a team
Description: The list of Time Off Reasons.
Properties:
Name |
Type |
Summary |
@odata.context |
string
|
|
value |
array of (ValueItem) Array containing Time Off Reasons |
The list of Time Off Reasons. |
Summary: Single Time Off Reason.
Description: Time Off Reason.
Properties:
Name |
Type |
Summary |
id |
string Time Off Reason ID |
The unique ID of the Time Off Reason. |
createdDateTime |
string(date-time) Created Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
lastModifiedDateTime |
string(date-time) Modified Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
displayName |
string Display Name |
Display Name |
iconType |
string Icon Type |
Icon Type |
isActive |
boolean Is Active |
Is Active |
Summary:
Description:
Properties:
Name |
Type |
Summary |
@odata.context |
string
|
|
value |
array of (OfferShiftRequestResponse) Offer Shift Requests List |
List of Offer Shift requests. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
@odata.context |
string
|
|
value |
array of (OpenShiftChangeRequestResponse) Open Shift Change Requests List |
List of Open Shift Change Requests. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
@odata.context |
string
|
|
value |
array of (OpenShiftResponse) Open Shifts List |
List of Open Shifts |
Summary:
Description:
Properties:
Name |
Type |
Summary |
@odata.context |
string
|
|
value |
array of (SchedulingGroupResponse) Scheduling Groups List |
List of Scheduling Groups. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
@odata.context |
string
|
|
value |
array of (ShiftResponse) Shifts List |
List of Shifts |
Summary:
Description:
Properties:
Name |
Type |
Summary |
@odata.context |
string
|
|
value |
array of (SwapShiftsChangeRequestResponse) Swap Shifts Change Requests List |
List of Swap Shifts Change Requests. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
@odata.context |
string
|
|
value |
array of (TimeOffRequestResponse) Time Off Requests List |
List of Time Off requests. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
@odata.context |
string
|
|
value |
array of (TimeOffResponse) Time Off Instances List |
List of Time Off instances |
Summary:
Description: Approve an Offer Shift request.
Properties:
Name |
Type |
Summary |
message |
string Message From Recipient/Manager |
A message when a request is accepted. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: Recipient/Manager declines an Offer Shift request.
Properties:
Name |
Type |
Summary |
message |
string Message From Recipient/Manager |
A message when a request is declined. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary: Offer Shift Request
Description: Offer Shift Request Entity
Properties:
Name |
Type |
Summary |
id |
string ID |
The unique ID of the Offer Shift request. |
createdDateTime |
string(date-time) Created Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
lastModifiedDateTime |
string(date-time) Modified Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
assignedTo |
string Assigned To |
The person the request is assigned to: 'manager' or 'recipient' Values: [mananger, recipient] |
state |
string State |
'approved', 'pending' or 'declined' |
senderDateTime |
string(date-time) Sender Time |
Time when the request was sent |
senderMessage |
string Sender Message |
The message from the request sender |
senderUserId |
string Sender ID |
The ID of the user that sent the request |
senderShiftId |
string Sender Shift ID |
The ID of the Shift from the sender |
recipientActionDateTime |
string(date-time) Receiver Time |
Time when the recipient responded |
recipientActionMessage |
string Recipient Message |
The message from the recipient |
recipientUserId |
string Recipient ID |
The ID of the recipient of the request |
managerActionDateTime |
string(date-time) Manager Action Time |
Time when the manager responded |
managerActionMessage |
string Manager Message |
The message from the manager |
managerUserId |
string Manager ID |
The ID of the manager that responded |
Summary:
Description: Manager approves an Open Shift change request.
Properties:
Name |
Type |
Summary |
message |
string Message From Manager |
A message from the manager to the sender/recipient when a request is accepted. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: Manager declines an Open Shift change request.
Properties:
Name |
Type |
Summary |
message |
string Message From Manager |
A message from the manager to the sender/recipient when a request is declined. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary: Open Shift Change Request
Description: Open Shift Change Request Entity
Properties:
Name |
Type |
Summary |
id |
string ID |
The unique ID of the Open Shift Change request. |
createdDateTime |
string(date-time) Created Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
lastModifiedDateTime |
string(date-time) Modified Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
assignedTo |
string Assigned To |
The person the request is assigned to: 'manager' or 'recipient' Values: [mananger, recipient] |
state |
string State |
'approved', 'pending' or 'declined' |
senderDateTime |
string(date-time) Sender Time |
Time when the request was sent |
senderMessage |
string Sender Message |
The message from the request sender |
senderUserId |
string Sender ID |
The ID of the user that sent the request |
managerActionDateTime |
string(date-time) Manager Action Time |
Time when the manager responded |
managerActionMessage |
string Manager Message |
The message from the manager |
managerUserId |
string Manager ID |
The ID of the manager that responded |
openShiftId |
string Open Shift ID |
The ID of the Open Shift being requested |
Summary: Open Shift
Description: Open Shift Entity
Properties:
Name |
Type |
Summary |
id |
string ID |
The unique ID of the Open Shift. |
createdDateTime |
string(date-time) Created Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
lastModifiedDateTime |
string(date-time) Modified Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
schedulingGroupId |
string Scheduling Group ID |
Scheduling Group ID |
sharedOpenShift |
|
Shared version of the Open Shift |
draftOpenShift |
Draft Changes > |
Preliminary version of the Open Shift |
Summary:
Description:
Properties:
Name |
Type |
Summary |
expirationDateTime |
string
|
Specify the date and time, in UTC format, of when the Microsoft Graph webhook subscription expires. The maximum expiration time for security alerts is 43200 minutes (under 30 days). |
Summary:
Description: Schedule Entity.
Properties:
Name |
Type |
Summary |
id |
string Schedule ID |
The unique ID of the Schedule. |
timeZone |
string Schedule Time Zone |
The Time Zone of the Schedule. |
provisionStatus |
string Schedule Provision Status |
The Provision Status of the Schedule. |
provisionStatusCode |
string Schedule Provision Status Code |
The Provision Status Code of the Schedule. |
Summary: Scheduling Group
Description: Scheduling Group Entity
Properties:
Name |
Type |
Summary |
id |
string ID |
The unique ID of the Scheduling Group. |
displayName |
string Display Name |
The display name for the Scheduling Group. |
isActive |
boolean Is Active |
Indicates whether the Scheduling Group can be used when creating new entities or updating existing ones. |
userIds |
array of (string) User IDs |
List of IDs of users in the Scheduling Group. |
Summary:
Description: Shared version of the Open Shift
Properties:
Name |
Type |
Summary |
displayName |
string Display Name |
Display Name |
notes |
string Notes |
Notes |
startDateTime |
string(date-time) Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
endDateTime |
string(date-time) End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
theme |
string Theme |
Theme color. Values: [white, blue, green, purple, pink, yellow, gray, darkblue, darkgreen, darkpurple, darkpink, darkyellow] |
openSlotCount |
integer Open Slot Count |
Open Slot Count |
activities |
array of (ActivitiesItem) Activities |
Shift activities |
Summary: Activity
Description: Shift activity
Properties:
Name |
Type |
Summary |
isPaid |
boolean Is Paid |
Is Paid |
startDateTime |
string(date-time) Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
endDateTime |
string(date-time) End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
code |
string Code |
Code |
displayName |
string Display Name |
Display Name |
Summary:
Description: Shared version of the Shift.
Properties:
Name |
Type |
Summary |
displayName |
string Display Name |
Display Name. |
notes |
string Notes |
Shift Notes. |
startDateTime |
string(date-time) Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
endDateTime |
string(date-time) End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
theme |
string Theme |
Theme color. Values: [white, blue, green, purple, pink, yellow, gray, darkblue, darkgreen, darkpurple, darkpink, darkyellow] |
activities |
array of (ActivitiesItem) Activities |
Shift activities |
Summary: Activity
Description: Shift activity
Properties:
Name |
Type |
Summary |
isPaid |
boolean Is Paid |
Is Paid |
startDateTime |
string(date-time) Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
endDateTime |
string(date-time) End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
code |
string Code |
Code |
displayName |
string Display Name |
Display Name |
Summary:
Description: Shared version of the Time Off.
Properties:
Name |
Type |
Summary |
timeOffReasonId |
string Time Off Reason ID |
Time Off Reason ID. |
startDateTime |
string(date-time) Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
endDateTime |
string(date-time) End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
theme |
string Theme |
Theme color. Values: [white, blue, green, purple, pink, yellow, gray, darkblue, darkgreen, darkpurple, darkpink, darkyellow] |
Summary: Shift
Description: Shift Entity.
Properties:
Name |
Type |
Summary |
id |
string ID |
The unique ID of the Shift. |
createdDateTime |
string(date-time) Created Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
lastModifiedDateTime |
string(date-time) Modified Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
userId |
string Assigned To User ID |
Assigned To User ID. |
schedulingGroupId |
string Scheduling Group ID |
Scheduling Group ID. |
sharedShift |
|
Shared version of the Shift. |
draftShift |
Draft Changes > |
Preliminary version of the Shift |
Summary:
Description: Approve a Swap Shifts change request.
Properties:
Name |
Type |
Summary |
message |
string Message From Recipient/Manager |
A message when a request is accepted. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: Decline a Swap Shifts change request.
Properties:
Name |
Type |
Summary |
message |
string Message From Recipient/Manager |
A message when a request is declined. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary: Swap Shift Request
Description: Swap Shift Request Entity
Properties:
Name |
Type |
Summary |
id |
string ID |
The unique ID of the Swap Shift request. |
createdDateTime |
string(date-time) Created Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
lastModifiedDateTime |
string(date-time) Modified Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
assignedTo |
string Assigned To |
The person the request is assigned to: 'manager' or 'recipient' Values: [mananger, recipient] |
state |
string State |
'approved', 'pending' or 'declined' |
senderDateTime |
string(date-time) Sender Time |
Time when the request was sent |
senderMessage |
string Sender Message |
The message from the request sender |
senderUserId |
string Sender ID |
The ID of the user that sent the request |
senderShiftId |
string Sender Shift ID |
The ID of the Shift from the sender |
recipientActionDateTime |
string(date-time) Receiver Time |
Time when the recipient responded |
recipientActionMessage |
string Recipient Message |
The message from the recipient |
recipientUserId |
string Recipient ID |
The ID of the recipient of the request |
recipientShiftId |
string Recipient Shift ID |
The ID of the Shift from the recipient |
managerActionDateTime |
string(date-time) Manager Action Time |
Time when the manager responded |
managerActionMessage |
string Manager Message |
The message from the manager |
managerUserId |
string Manager ID |
The ID of the manager that responded |
Summary:
Description: Manager approves a Time Off request.
Properties:
Name |
Type |
Summary |
message |
string Message From Manager |
A message from the manager to the sender/recipient when a request is accepted. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: Manager declines a Time Off request.
Properties:
Name |
Type |
Summary |
message |
string Message From Manager |
A message from the manager to the sender/recipient when a request is declined. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary: Time Off Request
Description: Time Off Request Entity
Properties:
Name |
Type |
Summary |
id |
string ID |
The unique ID of the Time Off request. |
createdDateTime |
string(date-time) Created Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
lastModifiedDateTime |
string(date-time) Modified Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
assignedTo |
string Assigned To |
The person the request is assigned to: 'manager' or 'recipient' Values: [mananger, recipient] |
state |
string State |
'approved', 'pending' or 'declined' |
senderDateTime |
string(date-time) Sender Time |
Time when the request was sent |
senderMessage |
string Sender Message |
The message from the request sender |
senderUserId |
string Sender ID |
The ID of the user that sent the request |
managerActionDateTime |
string(date-time) Manager Action Time |
Time when the manager responded |
managerActionMessage |
string Manager Message |
The message from the manager |
managerUserId |
string Manager ID |
The ID of the manager that responded |
startDateTime |
string(date-time) Start Time |
Start of time requested off |
endDateTime |
string(date-time) End Time |
End of time requested off |
timeOffReasonId |
string Time Off Reason ID |
The ID of the Time Off Reason |
Summary: Time Off
Description: Time Off Entity.
Properties:
Name |
Type |
Summary |
id |
string ID |
The unique ID of the Time Off. |
createdDateTime |
string(date-time) Created Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
lastModifiedDateTime |
string(date-time) Modified Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
userId |
string Assigned To User ID |
Assigned To User ID. |
sharedTimeOff |
|
Shared version of the Time Off. |
draftTimeOff |
Draft Changes > |
Preliminary version of the Time Off |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
notificationUrl |
string
|
Specify a well-formed URL of the endpoint that will receive notifications. |