Schedule Sync Targets
API endpoints for schedule sync targets
The schedule sync target object
A sync target is the link between incident.io and a single Slack user group, used to keep that group's membership in step with who is currently on call.
A target identifies the group by its Slack user group ID and Slack team ID, and remembers whether the incident.io bot should be added to the group so it can manage membership. On its own a target does nothing: you link it to a schedule by creating a schedule sync rule (see the Schedules service), and that rule decides which schedule members flow into the group. As the schedule's shifts change hands, we update the Slack user group to match.
A single target can be referenced by sync rules on several schedules at once; linked_schedules lists every schedule with an active rule pointing at it.
Whether the incident.io bot should be added to the group as a member. This is needed for some Slack configurations to let us manage the group's membership.
true
"2021-08-17T13:28:57.801578Z"
Unique identifier of the sync target
"01JXYZ000000000000000000AB"
Schedules with an active sync rule pointing at this target
Show child attributes
Show child attributes
[ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": ["01JPQA75EPNEES4479P16P4XAB"] } ]
Slack team (workspace) ID the user group lives in. On Enterprise Grid this identifies which workspace within the org the group belongs to.
"T02A1AZHG3J"
Slack ID of the user group whose membership is kept in sync. This is the Slack-assigned group ID (starting with 'S'), not the @-handle.
"S06MNNU5BMK"
"2021-08-17T13:28:57.801578Z"
Was this page helpful?
{
"add_bot_to_group": true,
"created_at": "2021-08-17T13:28:57.801578Z",
"id": "01JXYZ000000000000000000AB",
"linked_schedules": [
{
"id": "01G0J1EXE7AXZ2C93K61WBPYEH",
"name": "Primary On-Call Schedule",
"team_ids": [
"01JPQA75EPNEES4479P16P4XAB"
]
}
],
"slack_team_id": "T02A1AZHG3J",
"slack_user_group_id": "S06MNNU5BMK",
"updated_at": "2021-08-17T13:28:57.801578Z"
}