incident.io

https://docs.incident.io
Admin
incident.io is an incident management and response platform that helps teams declare, investigate,...
Tokens:1,066,683
Snippets:9,205
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Date-Time Examples

Source: https://docs.incident.io/api-reference/maintenancewindows-v1/update

Examples for timestamp fields.

```text
2021-08-17T13:28:57.801578Z
```

```text
2021-08-17T13:28:57.801578Z
```

--------------------------------

### OpenAPI Readiness Rule Example

Source: https://docs.incident.io/api-reference/policies-v2/show

Example configuration for high and low urgency readiness rules.

```yaml
high_urgency:
  - max_delay_seconds: 300
    method_types:
      - slack
low_urgency:
  - max_delay_seconds: 300
    method_types:
      - slack
```

--------------------------------

### Entry Window Start Query Parameter

Source: https://docs.incident.io/api-reference/schedule-entries-v2/list

The start of the window to get entries for. This parameter also accepts an opaque pagination cursor returned in pagination_meta.after.

```text
2021-01-01T00:00:00Z
```

--------------------------------

### Incident Types List Response Example

Source: https://docs.incident.io/api-reference/incident-types-v1/list

The JSON structure returned by the /v1/incident_types GET request, containing a list of incident types.

```json
{
  "incident_types": [
    {
      "create_in_triage": "always",
      "created_at": "2021-08-17T13:28:57.801578Z",
      "description": "Customer facing production outages",
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "is_default": false,
      "name": "Production Outage",
      "owning_team_ids": [
        "01G0J1EXE7AXZ2C93K61WBPYEH"
      ],
      "private_incidents_only": false,
      "updated_at": "2021-08-17T13:28:57.801578Z"
    }
  ]
}
```

--------------------------------

### AlertSourceRateLimitShardingV2 Example

Source: https://docs.incident.io/api-reference/alert-sources-v2/show

Example configuration for rate limit sharding using a JSON path key.

```json
{
  "rate_limit_shard_key_path": "$.priority"
}
```

--------------------------------

### Send heartbeat ping via curl

Source: https://docs.incident.io/alerts/heartbeat-monitoring

Configure your service to send a GET or POST request to the ping URL. The heartbeat monitoring will not start until the first successful ping is received.

```bash
curl https://api.incident.io/v2/heartbeat/<your-source-id>/ping \
  -H "Authorization: Bearer <your-token>"
```

--------------------------------

### CatalogCreateEntryResultV3 Schema Example

Source: https://docs.incident.io/api-reference/catalog-entries-v3/create-entry

Example response returned after successfully creating a catalog entry, containing the full entry details including timestamps.

```yaml
example:
  catalog_entry:
    aliases:
      - lawrence@incident.io
      - lawrence
    archived_at: '2021-08-17T14:28:57.801578Z'
    attribute_values:
      abc123:
        array_value:
          - label: Lawrence Jones
            literal: SEV123
        value:
          label: Lawrence Jones
          literal: SEV123
    catalog_type_id: 01FCNDV6P870EA6S7TK1DSYDG0
    created_at: '2021-08-17T13:28:57.801578Z'
    external_id: 761722cd-d1d7-477b-ac7e-90f9e079dc33
    id: 01FCNDV6P870EA6S7TK1DSYDG0
    name: Primary On-call
    rank: 3
    updated_at: '2021-08-17T13:28:57.801578Z'
```

--------------------------------

### PolicyAssignmentRulesV2 Example

Source: https://docs.incident.io/api-reference/policies-v2/create

Example configuration for policy assignment rules, including user bindings and reminder cadences.

```yaml
bindings:
  - array_value:
      - label: Lawrence Jones
        literal: SEV123
        reference: incident.severity
    value:
      label: Lawrence Jones
      literal: SEV123
      reference: incident.severity
reminder_cadence_after:
  interval: daily
reminder_cadence_before:
  interval: daily
reminder_detected_date_offset_hours:
  - 0
  - 48
reminder_due_date_offset_hours:
  - -24
  - 0
  - 24
```

--------------------------------

### ScheduleConfigCreatePayloadV2 Example

Source: https://docs.incident.io/api-reference/schedules-v2/create

Example payload for creating a schedule configuration, including rotation details.

```yaml
example:
  rotations:
    - effective_from: '2021-08-17T13:28:57.801578Z'
      handover_start_at: '2021-08-17T13:28:57.801578Z'
      handovers:
        - interval: 1
          interval_type: hourly
      id: 01G0J1EXE7AXZ2C93K61WBPYEH
      layers:
        - id: 01G0J1EXE7AXZ2C93K61WBPYEH
          name: Layer 1
      name: My Rotation
      scheduling_mode: fair
      users:
        - email: bob@example.com
          id: 01G0J1EXE7AXZ2C93K61WBPYEH
          slack_user_id: USER123
      working_interval:
        - end_time: '17:00'
          start_time: '09:00'
          weekday: monday
      working_intervals:
        - end_time: '17:00'
          start_time: '09:00'
          weekday: monday
```

--------------------------------

### WorkflowDelayV2 Example

Source: https://docs.incident.io/api-reference/workflows-v2/update

An example of the delay configuration for a workflow.

```json
{
        conditions_apply_over_delay: false,
        for_seconds: 60
      }
```

--------------------------------

### CatalogTypeAttributePathItemPayloadV3 Schema Example

Source: https://docs.incident.io/api-reference/catalog-types-v3/update-type-schema

Example of the CatalogTypeAttributePathItemPayloadV3 object.

```yaml
example:
  attribute_id: abc123
```

--------------------------------

### Channel Configuration Example

Source: https://docs.incident.io/api-reference/alert-routes-v2/update

Example configuration for channel-specific settings including condition groups and targets.

```yaml
- condition_groups:
    - conditions:
        - operation: one_of
          param_bindings:
            - array_value:
                - literal: SEV123
                  reference: incident.severity
              value:
                literal: SEV123
                reference: incident.severity
          subject: incident.severity
  ms_teams_targets:
```

--------------------------------

### Error List Example

Source: https://docs.incident.io/api-reference/catalog-entries-v3/list-entries

Example of a list of errors.

```yaml
- code: trial_expired
              message: Default incident call link must be a valid URL
              metadata:
                abc123: abc123
              source:
                field: default_call_url
                pointer: /settings/default_call_url
```

--------------------------------

### Maintenance Window Configuration Example

Source: https://docs.incident.io/api-reference/maintenancewindows-v1/create

An example payload demonstrating the structure for creating a maintenance window, including notification settings and timing.

```yaml
notification_message: Scheduled downtime for database migration
notify_channels:
  - channel_id: C0ACTHQMHS8
    channel_name: general
    channel_type: public
notify_end_minutes_before: 5
notify_start_minutes_before: 15
reroute_on_end: false
resolve_on_end: false
show_in_sidebar: true
start_at: '2021-08-17T13:28:57.801578Z'
```

--------------------------------

### PolicyReminderCadenceV2 Example

Source: https://docs.incident.io/api-reference/policies-v2/show

Example of a recurring reminder cadence configuration.

```yaml
interval: daily
```

--------------------------------

### Notify Start/End Minutes Example

Source: https://docs.incident.io/api-reference/maintenancewindows-v1/update

Examples for notification timing settings.

```json
5
```

```json
15
```

--------------------------------

### Incident Reference Example

Source: https://docs.incident.io/api-reference/incidents-v2/list

Example of an incident reference string.

```yaml
INC-123
```

--------------------------------

### Schedule Configuration Example

Source: https://docs.incident.io/api-reference/schedules-v2/create

An example of a schedule configuration object, including rotation details, user assignments, and working intervals.

```yaml
incident.io/terraform/version: version-of-terraform
        config:
          rotations:
            - effective_from: '2021-08-17T13:28:57.801578Z'
              handover_start_at: '2021-08-17T13:28:57.801578Z'
              handovers:
                - interval: 1
                  interval_type: hourly
              id: 01G0J1EXE7AXZ2C93K61WBPYEH
              layers:
                - id: 01G0J1EXE7AXZ2C93K61WBPYEH
                  name: Layer 1
              name: My Rotation
              scheduling_mode: fair
              users:
                - email: bob@example.com
                  id: 01G0J1EXE7AXZ2C93K61WBPYEH
                  slack_user_id: USER123
              working_interval:
                - end_time: '17:00'
                  start_time: '09:00'
                  weekday: monday
              working_intervals:
                - end_time: '17:00'
                  start_time: '09:00'
                  weekday: monday
        holidays_public_config:
          country_codes:
            - abc123
        name: Primary On-call Schedule
        team_ids:
          - 01JPQA75EPNEES4479P16P4XAB
        timezone: America/Los_Angeles
```

--------------------------------

### Incident Permalink Example

Source: https://docs.incident.io/api-reference/incidents-v2/list

Example of a permanent link to an incident.

```yaml
https://app.incident.io/incidents/123
```

--------------------------------

### Incident Name Example

Source: https://docs.incident.io/api-reference/incidents-v2/list

Example of an incident explanation or name.

```yaml
Our database is sad
```

--------------------------------

### Alert Source Configuration Example

Source: https://docs.incident.io/api-reference/alert-sources-v2/list

A comprehensive example of an alert source object, demonstrating configuration for email options, HTTP custom options, and heartbeat settings.

```yaml
alert_events_url: >-
    https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66
  auto_resolve_incident_alerts: false
  auto_resolve_timeout_minutes: 1
  azure_devops_options:
    project_ids:
      - 01GBSQF3FHF7FWZQNWGHAVQ804
      - ba038695-f5f7-4490-a9ea-bf4ab3cbf483
  email_options:
    email_address: lawrence@example.com
    redactions:
      - credit_card_numbers
    transform_expression: |-
      return {
        title: $.subject,
        description: $.text,
        status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',
        deduplication_key: $.header_message_id,
      }
  filter_condition_groups:
    - conditions:
        - operation:
            label: Lawrence Jones
            value: 01FCQSP07Z74QMMYPDDGQB9FTG
          param_bindings:
            - array_value:
                - label: Lawrence Jones
                  literal: SEV123
                  reference: incident.severity
              value:
                label: Lawrence Jones
                literal: SEV123
                reference: incident.severity
          subject:
            label: Incident Severity
            reference: incident.severity
  fixed_team_id: 01G0J1EXE7AXZ2C93K61WBPYEH
  heartbeat_options:
    failure_threshold: 1
    grace_period_seconds: 0
    interval_seconds: 60
    ping_url: >-
      https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping
  http_custom_options:
    deduplication_key_path: $.alert_id
    transform_expression: |-
      return {
        title: $.title || $.name || 'Unknown Alert',
        status: $.status === 'resolved' ? 'resolved' : 'firing',
        description: $.description || $.message || '',
        sourceURL: $.url || $.link || '',
        metadata: { team: $.team, severity: $.severity }
      }
  id: 01GW2G3V0S59R238FAHPDS1R66
  jira_options:
    project_ids:
      - 01GBSQF3FHF7FWZQNWGHAVQ804
      - '10043'
  name: Production Web Dashboard Alerts
  owning_team_ids:
    - 01G0J1EXE7AXZ2C93K61WBPYEH
  rate_limit_sharding:
    rate_limit_shard_key_path: $.priority
  secret_token: some-secret-token
  source_type: alertmanager
  template:
    attributes:
      - alert_attribute_id: abc123
        binding:
          array_value:
            - label: Lawrence Jones
              literal: SEV123
              reference: incident.severity
          merge_strategy: first_wins
          value:
            label: Lawrence Jones
            literal: SEV123
            reference: incident.severity
    description:
      label: Lawrence Jones
      literal: SEV123
      reference: incident.severity
    expressions:
      - else_branch:
          result:
            array_value:
              - label: Lawrence Jones
                literal: SEV123
                reference: incident.severity
            value:
              label: Lawrence Jones
              literal: SEV123
              reference: incident.severity
```

--------------------------------

### Incident ID Example

Source: https://docs.incident.io/api-reference/incidents-v2/list

Example of a unique identifier for an incident.

```yaml
01FDAG4SAP5TYPT98WGR2N7W91
```

--------------------------------

### EscalationPathNodeLevelV2 Example

Source: https://docs.incident.io/api-reference/escalation-paths-v2/list

Example configuration for an escalation path level, including retry and round-robin settings.

```yaml
ack_mode: all
retry_config:
  attempts: 3
  interval_seconds: 300
round_robin_config:
  enabled: false
  rotate_after_seconds: 120
targets:
  - id: lawrencejones
    schedule_mode: currently_on_call
    selected_rota_id: 01FCNDV6P870EA6S7TK1DSYDG0
    type: schedule
    urgency: high
time_to_ack_interval_condition: active
time_to_ack_seconds: 1800
time_to_ack_weekday_interval_config_id: 01FCNDV6P870EA6S7TK1DSYDG0
```

--------------------------------

### Boolean Flag Examples

Source: https://docs.incident.io/api-reference/maintenancewindows-v1/update

Examples for boolean configuration flags.

```json
false
```

```json
false
```

```json
true
```

--------------------------------

### Schedule Sync Target Creation Response Example

Source: https://docs.incident.io/api-reference/schedule-sync-targets-v2/create

This example shows the structure of a successful response when creating a schedule sync target.

```json
example:
  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'
```

--------------------------------

### Escalation Path V2 Properties Example

Source: https://docs.incident.io/api-reference/escalation-paths-v2/list

Detailed example showing the properties of an EscalationPathV2 object, including current responders and path configuration.

```yaml
current_responders:
          description: Users who are currently on-call for this escalation path
          example:
            - email: lisa@incident.io
              id: 01FCNDV6P870EA6S7TK1DSYDG0
              name: Lisa Karlin Curtis
              role: owner
              slack_user_id: U02AYNF2XJM
          items:
            $ref: '#/components/schemas/UserV2'
          type: array
        id:
          description: Unique identifier for this escalation path.
          example: 01FCNDV6P870EA6S7TK1DSYDG0
          type: string
        name:
          description: The name of this escalation path, for the user's reference.
          example: Urgent Support
          type: string
        path:
          description: The nodes that form the levels and branches of this escalation path.
          example:
            - delay:
                delay_interval_condition: active
                delay_seconds: 300
                delay_weekday_interval_config_id: 01FCNDV6P870EA6S7TK1DSYDG0
              escalation_path:
                escalation_path_id: 01FCNDV6P870EA6S7TK1DSYDG0
              id: 01FCNDV6P870EA6S7TK1DSYDG0
              if_else:
                conditions:
                  - operation:
                      label: Lawrence Jones
                      value: 01FCQSP07Z74QMMYPDDGQB9FTG
                    param_bindings:
                      - array_value:
                          - label: Lawrence Jones
                            literal: SEV123
                            reference: incident.severity
                        value:
                          label: Lawrence Jones
```

--------------------------------

### Notification Message Example

Source: https://docs.incident.io/api-reference/maintenancewindows-v1/update

Example of a custom notification message.

```text
Scheduled downtime for database migration
```

--------------------------------

### IncidentsListResultV1 Schema Example

Source: https://docs.incident.io/api-reference/incidents-v1/list

Example of the IncidentsListResultV1 schema definition.

```yaml
        incidents:
          - call_url: https://zoom.us/foo
            created_at: '2021-08-17T13:28:57.801578Z'
```

--------------------------------

### Channel Configuration Schema Example

Source: https://docs.incident.io/api-reference/alert-routes-v2/update

Example structure for defining channel configurations, including Slack and MS Teams targets with associated bindings.

```yaml
- condition_groups:
    - conditions:
        - operation:
            label: Lawrence Jones
            value: 01FCQSP07Z74QMMYPDDGQB9FTG
          param_bindings:
            - array_value:
                - label: Lawrence Jones
                  literal: SEV123
                  reference: incident.severity
              value:
                label: Lawrence Jones
                literal: SEV123
                reference: incident.severity
          subject:
            label: Incident Severity
            reference: incident.severity
  ms_teams_targets:
    binding:
      array_value:
        - label: Lawrence Jones
          literal: SEV123
          reference: incident.severity
      value:
        label: Lawrence Jones
        literal: SEV123
        reference: incident.severity
    channel_visibility: abc123
  slack_targets:
    binding:
      array_value:
        - label: Lawrence Jones
          literal: SEV123
          reference: incident.severity
      value:
        label: Lawrence Jones
        literal: SEV123
        reference: incident.severity
    channel_visibility: abc123
```
Tokens:
Raw