Incidents

Link a page to an incident

Link an existing on-call page to an incident.

post/api/v2/incidents/{incident_id}/pages/link

Request

Path parameters

incident_idstring required

The UUID of the incident.

Request body

Example request

{
  "data": {
    "attributes": {
      "key": "PAGE-12345",
      "page_target": {
        "identifier": "my-oncall-team",
        "type": "team_handle"
      },
      "team_id": "team-abc-123"
    },
    "id": "PAGE-12345",
    "type": "page"
  }
}

Response

Created

Example response

{
  "data": {
    "attributes": {
      "incident_id": "00000000-aaaa-0000-0000-000000000000",
      "integration_type": 1,
      "metadata": {
        "channels": []
      }
    },
    "id": "00000000-0000-0000-1234-000000000000",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "00000000-0000-0000-2345-000000000000",
          "type": "users"
        }
      },
      "last_modified_by_user": {
        "data": {
          "id": "00000000-0000-0000-2345-000000000000",
          "type": "users"
        }
      }
    },
    "type": "incident_integrations"
  },
  "included": [
    {
      "relationships": {
        "org": {
          "data": {
            "id": "00000000-0000-beef-0000-000000000000",
            "type": "orgs"
          }
        },
        "other_orgs": {
          "data": []
        },
        "other_users": {
          "data": []
        },
        "roles": {
          "data": [
            {
              "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
              "type": "roles"
            }
          ]
        }
      },
      "type": "users"
    }
  ]
}

Changes

Changes to this operation have not been checked yet.