### 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 ``` -------------------------------- ### 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 } ``` -------------------------------- ### Notify Start/End Minutes Example Source: https://docs.incident.io/api-reference/maintenancewindows-v1/update Examples for notification timing settings. ```json 5 ``` ```json 15 ``` -------------------------------- ### ExpressionBranchesOptsPayloadV3 Example Source: https://docs.incident.io/api-reference/incident-templates-v1/update Example payload for configuring expression branches. ```json { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } } ``` -------------------------------- ### Boolean Flag Examples Source: https://docs.incident.io/api-reference/maintenancewindows-v1/update Examples for boolean configuration flags. ```json false ``` ```json false ``` ```json true ``` -------------------------------- ### Source Type Example Source: https://docs.incident.io/api-reference/alert-sources-v2/create Example of a source type string. ```text alertmanager ``` -------------------------------- ### EscalationPathRepeatConfigV2 Schema Example Source: https://docs.incident.io/api-reference/escalation-paths-v2/update Example configuration for repeating an escalation path. ```yaml delay_repeat_on_activity: false repeat_after_seconds: 1800 ``` -------------------------------- ### ExpressionCastOptsV2 Schema Example Source: https://docs.incident.io/api-reference/policies-v2/show Example configuration for ExpressionCastOptsV2, specifying the return metadata. ```yaml example: returns: array: true type: IncidentStatus ``` -------------------------------- ### EscalationPathNodeNotifyChannelV2 Example Source: https://docs.incident.io/api-reference/escalation-paths-v2/list Example configuration for an escalation path notification channel. ```yaml 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 ``` -------------------------------- ### CatalogEntrySlimV3V3 Schema Example Source: https://docs.incident.io/api-reference/teams-v3/list Example structure for a slim catalog entry. ```yaml external_id: 761722cd-d1d7-477b-ac7e-90f9e079dc33 id: 01FCNDV6P870EA6S7TK1DSYDG0 name: Primary On-call ``` -------------------------------- ### FollowUpPriorityV2 Example Source: https://docs.incident.io/api-reference/follow-ups-v3/create Example object representing a follow-up priority option. ```yaml description: A follow-up that requires immediate attention. id: 01GNW4BAQ7XRMFF6FHKNXDFPRW name: Urgent rank: 10 ``` -------------------------------- ### Grouping Keys Example Source: https://docs.incident.io/api-reference/alert-routes-v2/update Example configuration for alert grouping keys. ```yaml description: Which attributes should this alert route use to group alerts? example: - reference: alert.title items: $ref: '#/components/schemas/GroupingKeyV2' type: array ``` -------------------------------- ### Pagination Meta Example Source: https://docs.incident.io/api-reference/catalog-entries-v3/list-entries Example of pagination metadata returned in the response. ```yaml pagination_meta: after: 01FCNDV6P870EA6S7TK1DSYDG0 page_size: 25 total_record_count: 238 ``` -------------------------------- ### 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 ``` -------------------------------- ### 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 ``` -------------------------------- ### 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" } ``` -------------------------------- ### Grouping Window Example Source: https://docs.incident.io/api-reference/alert-routes-v2/update Example configuration for the alert grouping window. ```yaml description: How large should the grouping window be? example: 1 format: int32 type: integer ``` -------------------------------- ### 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//ping \ -H "Authorization: Bearer " ``` -------------------------------- ### 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 ``` -------------------------------- ### 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 ``` -------------------------------- ### Incident Reference Example Source: https://docs.incident.io/api-reference/incidents-v2/list Example of an incident reference string. ```yaml INC-123 ``` -------------------------------- ### ScheduleEntryV2 Property Examples Source: https://docs.incident.io/api-reference/schedule-entries-v2/preview Examples for various properties within the ScheduleEntryV2 object. ```yaml end_at: '2021-08-17T13:28:57.801578Z' entry_id: 01G0J1EXE7AXZ2C93K61WBPYEH fingerprint: 01G0J1EXE7AXZ2C93K61WBPYEH layer_id: 01G0J1EXE7AXZ2C93K61WBPYNH ``` -------------------------------- ### 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 ``` -------------------------------- ### 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 ``` -------------------------------- ### Incident ID Example Source: https://docs.incident.io/api-reference/incidents-v2/list Example of a unique identifier for an incident. ```yaml 01FDAG4SAP5TYPT98WGR2N7W91 ``` -------------------------------- ### 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' ``` -------------------------------- ### ExpressionBranchesOptsV2 Example Source: https://docs.incident.io/api-reference/alert-sources-v2/create Configuration for expression branches, defining conditions and result mappings. ```yaml branches: - 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 result: array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity returns: array: true type: IncidentStatus ``` -------------------------------- ### 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' ``` -------------------------------- ### 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 ``` -------------------------------- ### 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 ``` -------------------------------- ### SeverityV1 Schema Example Source: https://docs.incident.io/api-reference/incidents-v1/show Example values for severity properties. ```yaml created_at: example: '2021-08-17T13:28:57.801578Z' description: example: Issues with **low impact**. id: example: 01FCNDV6P870EA6S7TK1DSYDG0 name: example: Minor rank: example: 1 updated_at: example: '2021-08-17T13:28:57.801578Z' ``` -------------------------------- ### List Resources 200 OK Response Example Source: https://docs.incident.io/api-reference/catalog-resources-v3/list-resources This JSON example shows the structure of a successful response when listing catalog resources, including details like category, description, and engine resource type. ```json { "resources": [ { "category": "custom", "description": "Boolean true or false value", "engine_resource_type": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "label": "GitHub Repository", "type": "Custom[\"Team\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string\nof /, e.g. incident-io/website" } ] } ``` -------------------------------- ### ExpressionFilterOptsPayloadV3 Example Source: https://docs.incident.io/api-reference/incident-templates-v1/update Example payload for expression filtering options. ```json { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] } ``` -------------------------------- ### ExpressionConcatenateOptsPayloadV3 Example Source: https://docs.incident.io/api-reference/incident-templates-v1/update Example payload for expression concatenation options. ```json { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" } ``` -------------------------------- ### ExpressionCastOptsPayloadV3 Example Source: https://docs.incident.io/api-reference/incident-templates-v1/update Example payload for expression casting options. ```json { "returns": { "array": true, "type": "IncidentStatus" } } ``` -------------------------------- ### AlertSourceHeartbeatOptionsV2 Example Source: https://docs.incident.io/api-reference/alert-sources-v2/show Example configuration for heartbeat monitoring, including failure thresholds and ping URL. ```json { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" } ``` -------------------------------- ### ScheduleV2 Resource Example Source: https://docs.incident.io/api-reference/schedules-v2/create An example of the ScheduleV2 resource, showing metadata, current shifts, and next shifts. ```yaml current_shifts: description: Shifts that are ongoing for this schedule example: - end_at: '2021-08-17T13:28:57.801578Z' entry_id: 01G0J1EXE7AXZ2C93K61WBPYEH fingerprint: 01G0J1EXE7AXZ2C93K61WBPYEH layer_id: 01G0J1EXE7AXZ2C93K61WBPYNH rotation_id: 01G0J1EXE7AXZ2C93K61WBPYEH start_at: '2021-08-17T13:28:57.801578Z' user: email: lisa@incident.io id: 01FCNDV6P870EA6S7TK1DSYDG0 name: Lisa Karlin Curtis role: owner slack_user_id: U02AYNF2XJM items: $ref: '#/components/schemas/ScheduleEntryV2' type: array next_shifts: description: >- The shifts after the next changeover. Note that on the list schedules endpoint, this will always be empty if the page size requested is greater than 25. example: - end_at: '2021-08-17T13:28:57.801578Z' entry_id: 01G0J1EXE7AXZ2C93K61WBPYEH fingerprint: 01G0J1EXE7AXZ2C93K61WBPYEH layer_id: 01G0J1EXE7AXZ2C93K61WBPYNH rotation_id: 01G0J1EXE7AXZ2C93K61WBPYEH start_at: '2021-08-17T13:28:57.801578Z' user: email: lisa@incident.io id: 01FCNDV6P870EA6S7TK1DSYDG0 name: Lisa Karlin Curtis role: owner slack_user_id: U02AYNF2XJM items: $ref: '#/components/schemas/ScheduleEntryV2' type: array ``` -------------------------------- ### EngineParamBindingPayloadV3 Example Source: https://docs.incident.io/api-reference/incident-templates-v1/validate Example of an engine parameter binding payload. ```yaml array_value: - literal: SEV123 ``` -------------------------------- ### PolicyFindingReadinessRuleV2 Schema Example Source: https://docs.incident.io/api-reference/policy-findings-v2/show Example object for a readiness rule, detailing the max delay and notification methods. ```yaml max_delay_seconds: 300 met: false method_types: - slack ``` -------------------------------- ### Create Policy Response Example Source: https://docs.incident.io/api-reference/policies-v2/create Example of the JSON response returned after successfully creating a policy. ```json policy: assignment_rules: 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 conditions: - 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 created_at: '2021-08-17T13:28:57.801578Z' debrief: due_date_config: ``` -------------------------------- ### IncidentTypesListResultV1 Schema Example Source: https://docs.incident.io/api-reference/incident-types-v1/list The schema example for the IncidentTypesListResultV1 component. ```json { "incident_types": [ { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages" } ] } ``` -------------------------------- ### AlertRouteTemplateBindingPayloadV2 Schema Example Source: https://docs.incident.io/api-reference/alert-routes-v2/update Example payload for binding a template. ```json { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ``` -------------------------------- ### AlertSourceAzureDevopsOptionsV2 Example Source: https://docs.incident.io/api-reference/alert-sources-v2/list Configuration example for Azure DevOps alert sources, specifying the project IDs to watch. ```yaml project_ids: - 01GBSQF3FHF7FWZQNWGHAVQ804 - ba038695-f5f7-4490-a9ea-bf4ab3cbf483 ``` -------------------------------- ### EscalationRespondSnoozeDetailsPayloadV2 Schema Example Source: https://docs.incident.io/api-reference/escalations-v2/respond Example payload for snoozing an escalation. ```yaml example: reason: Waiting for deployment to complete snooze_until: '2025-01-01T12:00:00Z' ``` -------------------------------- ### Actions V1 Show Path Parameter Example Source: https://docs.incident.io/api-reference/actions-v1/show Example of the 'id' path parameter required to identify the specific action. ```yaml default: summary: default value: 01FCNDV6P870EA6S7TK1DSYDG0 ``` -------------------------------- ### GroupingKeyV2 Schema Example Source: https://docs.incident.io/api-reference/alert-routes-v2/update Example of a grouping key reference. ```json { "reference": "alert.title" } ``` -------------------------------- ### EngineParamBindingValuePayloadV3 Example Source: https://docs.incident.io/api-reference/alert-routes-v3/update Example payload for binding a parameter value. ```yaml literal: SEV123 reference: incident.severity ``` -------------------------------- ### Schedule Preview Request Example Source: https://docs.incident.io/api-reference/schedule-entries-v2/preview Example of the data structure used to define the preview window for schedule entries. ```yaml entry_window_end: description: >- The end of the window to preview entries for. Defaults to four weeks after entry_window_start. example: '2021-01-08T00:00:00Z' format: date-time type: string entry_window_start: description: The start of the window to preview entries for. Defaults to now. example: '2021-01-01T00:00:00Z' format: date-time type: string ``` -------------------------------- ### ExpressionElseBranchV2 Example Source: https://docs.incident.io/api-reference/alert-sources-v2/update Example of an else branch result configuration. ```json result: array_value: - label: Lawrence Jones literal: SEV123 reference: incident.severity value: label: Lawrence Jones literal: SEV123 reference: incident.severity ``` -------------------------------- ### AlertSourceJiraOptionsV2 Example Source: https://docs.incident.io/api-reference/alert-sources-v2/show Example configuration for Jira alert sources, specifying project IDs to watch. ```json { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] } ``` -------------------------------- ### Expression Branches Options Example Source: https://docs.incident.io/api-reference/alert-routes-v3/update Example payload for ExpressionBranchesOptsV3, demonstrating multiple branches and return types. ```yaml branches: - condition_groups: - conditions: - operation: label: Lawrence Jones value: 01FCQSP07Z74QMMYPDDGQB9FTG param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: label: Priority reference: alert.priority result: array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity returns: array: true type: IncidentStatus ``` -------------------------------- ### CustomFieldOptionsCreatePayloadV1 Schema Example Source: https://docs.incident.io/api-reference/custom-field-options-v1/create Example structure for the CustomFieldOptionsCreatePayloadV1 schema. ```json { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10 } ``` -------------------------------- ### HTTP Status Example Source: https://docs.incident.io/api-reference/catalog-entries-v3/list-entries Example of an HTTP status integer. ```yaml 408 ``` -------------------------------- ### Request ID Example Source: https://docs.incident.io/api-reference/catalog-entries-v3/list-entries Example of a request ID string. ```yaml 2T1p0e3j ``` -------------------------------- ### AlertRouteChannelConfigV2 Schema Example Source: https://docs.incident.io/api-reference/alert-routes-v2/update Example configuration for AlertRouteChannelConfigV2, showing condition groups and targets for MS Teams and Slack. ```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 ``` -------------------------------- ### CatalogCreateEntryResultV2 Schema Example Source: https://docs.incident.io/api-reference/catalog-v2/create Example of the response returned after successfully creating a catalog entry, containing the created entry details. ```json { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation" } } } } } } ``` -------------------------------- ### CatalogEntryEngineParamBindingValueV3 Example Source: https://docs.incident.io/api-reference/catalog-entries-v3/show-entry Example structure for a parameter binding value. ```yaml label: Lawrence Jones literal: SEV123 ``` -------------------------------- ### Expression Label Example Source: https://docs.incident.io/api-reference/alert-routes-v3/show Example of a human-readable label for an expression. ```yaml label: description: The human readable label of the expression example: Team Slack channel type: string ``` -------------------------------- ### ScheduleSyncTargetsShowResultV2 Example Source: https://docs.incident.io/api-reference/schedule-sync-targets-v2/show Example JSON structure for a successful response when retrieving a schedule sync target. ```json { "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" } } ``` -------------------------------- ### TeamsShowResultV3 Schema Example Source: https://docs.incident.io/api-reference/teams-v3/show Example structure for the TeamsShowResultV3 schema component. ```yaml example: team: catalog_entry: external_id: 761722cd-d1d7-477b-ac7e-90f9e079dc33 ``` -------------------------------- ### SchedulesCreateScheduleSyncRuleResultV2 Example Source: https://docs.incident.io/api-reference/schedule-sync-rules-v2/create Example response returned after successfully creating a schedule sync rule. ```yaml schedule_sync_rule: created_at: '2021-08-17T13:28:57.801578Z' id: 01JXYZ000000000000000000CD permanent_member_user_ids: - 01G0J1EXE7AXZ2C93K61WBPYEH rotation_id: 01JXYZ000000000000000000RT schedule_id: 01JXYZ000000000000000000EF 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' schedule_sync_target_id: 01JXYZ000000000000000000AB sync_type: on_call updated_at: '2021-08-17T13:28:57.801578Z' ``` -------------------------------- ### ExpressionBranchesOptsPayloadV2 Example Source: https://docs.incident.io/api-reference/alert-sources-v2/update Example structure for ExpressionBranchesOptsPayloadV2, defining conditional branches and return types. ```yaml branches: - condition_groups: - conditions: - operation: one_of param_bindings: - array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity subject: incident.severity result: array_value: - literal: SEV123 reference: incident.severity value: literal: SEV123 reference: incident.severity returns: array: true type: IncidentStatus ``` -------------------------------- ### Workflow Steps Configuration Example Source: https://docs.incident.io/api-reference/workflows-v2/show Example structure for defining steps within a workflow, including parameter bindings for specific actions like PagerDuty escalation. ```json [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ] ``` -------------------------------- ### ScheduleV2 Current Shifts Example Source: https://docs.incident.io/api-reference/schedules-v2/show Example of ongoing shifts for a schedule. ```yaml - end_at: '2021-08-17T13:28:57.801578Z' entry_id: 01G0J1EXE7AXZ2C93K61WBPYEH fingerprint: 01G0J1EXE7AXZ2C93K61WBPYEH layer_id: 01G0J1EXE7AXZ2C93K61WBPYNH rotation_id: 01G0J1EXE7AXZ2C93K61WBPYEH start_at: '2021-08-17T13:28:57.801578Z' user: email: lisa@incident.io id: 01FCNDV6P870EA6S7TK1DSYDG0 name: Lisa Karlin Curtis role: owner slack_user_id: U02AYNF2XJM ``` -------------------------------- ### ScheduleHolidaysPublicConfigPayloadV2 Example Source: https://docs.incident.io/api-reference/schedule-entries-v2/preview Example payload for configuring holiday country codes. ```yaml country_codes: - abc123 ``` -------------------------------- ### Create an empty plugin and architecture documentation Source: https://docs.incident.io/investigations/extensions/getting-started The agent can create an empty plugin structure and interview the user to generate architecture documentation based on the repository contents. ```text > /incident-io:extensions create an empty plugin and then interview me to create architecture docs ● Created ops/.claude-plugin/plugin.json and ops/README.md. An empty plugin needs the manifest, or a sync finds nothing to read. Now the docs. I've read your repo rather than guessing, and I can see a Go service in server/, a React app in web/, and Terraform deploying both. You call this "the platform". Is that the Go service, the service plus the web app, or the whole deployable unit? > The Go service. The web app is a separate thing. ● Noted. When the web app breaks, do the same people check the same dashboards as when the Go service breaks? > Different teams entirely. ● Then they're two systems, and each gets its own directory. Next question: where does the Go service actually run? ``` -------------------------------- ### Retry-After Example Source: https://docs.incident.io/api-reference/schedule-entries-v2/preview Example of the retry_after field format as an RFC3339 timestamp. ```yaml example: '2020-01-01T00:00:00Z' ``` -------------------------------- ### Slack Channel ID Example Source: https://docs.incident.io/api-reference/incidents-v2/list Example of a Slack channel ID. ```yaml C02AW36C1M5 ``` -------------------------------- ### AlertSourceHeartbeatOptionsV2 Schema Example Source: https://docs.incident.io/api-reference/alert-sources-v2/update Example configuration for heartbeat monitoring, including failure thresholds, grace periods, and the ping URL. ```yaml failure_threshold: 1 grace_period_seconds: 0 interval_seconds: 60 ping_url: https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping ``` -------------------------------- ### IncidentDurationMetricV2 Schema Example Source: https://docs.incident.io/api-reference/incidents-v2/show Example object structure for an IncidentDurationMetricV2 entity. ```yaml example: id: 01FCNDV6P870EA6S7TK1DSYD5H name: Lasted ``` -------------------------------- ### CustomFieldValueV2 Schema Example Source: https://docs.incident.io/api-reference/incidents-v2/show Example object structure for a CustomFieldValueV2 entity. ```yaml example: value_catalog_entry: aliases: - lawrence@incident.io - lawrence external_id: 761722cd-d1d7-477b-ac7e-90f9e079dc33 id: 01FCNDV6P870EA6S7TK1DSYDG0 name: Primary On-call value_link: https://google.com/ value_numeric: '123.456' value_option: custom_field_id: 01FCNDV6P870EA6S7TK1DSYDG0 id: 01FCNDV6P870EA6S7TK1DSYDG0 sort_key: 10 value: Product value_text: This is my text field, I hope you like it ```