Skip to main content
PUT
/
v2
/
schedule_sync_targets
/
{id}
Update
curl --request PUT \
  --url https://api.incident.io/v2/schedule_sync_targets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "add_bot_to_group": true,
  "annotations": {
    "incident.io/terraform/version": "3.0.0"
  }
}
'
{
  "schedule_sync_target": {
    "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"
  }
}

Authorizations

​
Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

Path Parameters

​
id
string
required

The sync target ID

Example:

"abc123"

Body

application/json
​
add_bot_to_group
boolean
required

Whether the incident.io bot should be added to the group

Example:

true

​
annotations
object

Annotations that track metadata about this resource

Example:
{ "incident.io/terraform/version": "3.0.0" }

Response

200 - application/json

OK response.

​
schedule_sync_target
object
required

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.