Skip to main content

Incident.io

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable PyAirbyte
Connector type (beta)
Available Data replicationAvailable Agent(learn more)
Support Level
Airbyte
Connector Version
1.0.3 (last updated 2 hours ago)
Sync Success Rate
Medium
Usage Rate
High
Data workers used
0.2 per sync (Learn more)
Definition ID
7926da90-399e-4f9f-9833-52d8dc3fcb29

This page contains the setup guide and reference information for the Incident.io source connector.

Incident.io is an incident management platform that provides on-call scheduling, status pages, and incident response tooling. This connector reads your account's data through the Incident.io API.

Prerequisites​

  • An Incident.io account.
  • An Incident.io API key with permission to view the resources you want to sync. Step 1 explains how to create one, and the Supported Streams table lists the permission each stream needs.

Setup guide​

Step 1: Set up Incident.io​

  1. In Incident.io, go to Settings → API keys and create a key. Creating or editing keys requires the Manage API keys permission.
  2. Choose what the key can do. Keys can have account-level permissions, team-scoped permissions, or both, and you can only grant permissions that you hold yourself. The connector needs the view permission for every stream you plan to sync. The Supported Streams table names the permission for each stream.
  3. Copy the token. Incident.io shows it only once.

For more about keys and permissions, see Authentication in the Incident.io API reference.

Step 2: Set up the Incident.io connector in Airbyte​

For Airbyte Cloud​

  1. Log into your Airbyte Cloud account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Incident.io from the Source type dropdown.
  4. Enter a name for the Incident.io connector.
  5. For API Key, enter the key you created in Step 1.
  6. (Optional) Set Start Date, Time window, and Number of concurrent workers. See Configuration options.
  7. Click Set up source.

For Airbyte Open Source​

  1. Navigate to the Airbyte Open Source dashboard.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Incident.io from the Source type dropdown.
  4. Enter a name for the Incident.io connector.
  5. For API Key, enter the key you created in Step 1.
  6. (Optional) Set Start Date, Time window, and Number of concurrent workers. See Configuration options.
  7. Click Set up source.

Configuration options​

InputTypeDescriptionDefault Value
api_keystringAPI Key. An Incident.io API key with view permission for the streams you sync. Create it in Incident.io under Settings → API keys.
start_datestringStart Date. Only sync records updated on or after this UTC date-time, in the format YYYY-MM-DDTHH:MM:SSZ, for the incidents, alerts, escalations, actions, and follow-ups streams. Applies to both Full Refresh and Incremental syncs. The default predates all incident.io data. Streams read per incident, such as incident_attachments, follow the same scope and only cover incidents updated on or after this date.2020-01-01T00:00:00Z
time_windowstringTime window. Size of each date window requested from incident.io on incremental streams, in whole days as an ISO 8601 duration (for example P30D, P7D, P365D). The minimum is P1D because incidents and escalations filter by date. Smaller windows let more requests run in parallel on large accounts; larger windows mean fewer requests on small accounts. Defaults to P30D.P30D
num_workersintegerNumber of concurrent workers. Number of streams and partitions read in parallel, from 1 to 10. Higher values can speed up large syncs but use more of the incident.io rate limit (1,200 requests per minute per API key, 60 per minute on incidents).4

Supported sync modes​

The Incident.io source connector supports the following sync modes:

FeatureSupported?
Full Refresh SyncYes
Incremental SyncYes, on incidents, alerts, escalations, actions, and follow-ups, using updated_at

Incremental streams request updated_at in windows sized by the time_window option (default 30 days), resuming from the last synced timestamp with a small overlap so rows that commit slightly out of order are still captured. With the Append + Deduped destination sync mode those repeats are removed by primary key; with plain Append they are kept.

The start_date filter applies to the five incremental streams in every sync mode, including Full Refresh. If you set a start_date later than the default, Full Refresh syncs of these streams don't return records last updated before that date.

Supported Streams​

The Required permission column names the API key permission each stream needs, as the Incident.io API reference documents it. A key without that permission gets HTTP 403 on the stream; see Limitations & Troubleshooting.

StreamEndpointPrimary keyFull RefreshIncrementalRequired permission
actions/v3/actionsid✅✅actions.view
alert_attributes/v2/alert_attributesid✅❌alert_schema.view
alert_routes/v3/alert_routesid✅❌alert_routes.view
alert_sources/v2/alert_sourcesid✅❌alert_sources.view
alerts/v2/alertsid✅✅alerts.view
catalog_entries/v3/catalog_entriesid✅❌catalog_entries.view
catalog_resources/v3/catalog_resourcestype✅❌catalog_types.view
catalog_types/v3/catalog_typesid✅❌catalog_types.view
custom_field_options/v1/custom_field_optionsid✅❌custom_fields.view
custom_fields/v2/custom_fieldsid✅❌custom_fields.view
escalation_paths/v2/escalation_pathsid✅❌escalation_paths.view
escalations/v2/escalationsid✅✅escalations.view
follow-ups/v3/follow_upsid✅✅actions.view
incident_alerts/v2/incident_alertsid✅❌alerts.view
incident_attachments/v1/incident_attachmentsid✅❌attachments.view
incident_roles/v2/incident_rolesid✅❌incident_roles.view
incident_statuses/v1/incident_statusesid✅❌incident_statuses.view
incident_timestamps/v2/incident_timestampsid✅❌Not documented by Incident.io
incident_types/v1/incident_typesid✅❌incident_types.view
incident_updates/v2/incident_updatesid✅❌incidents.view
incidents/v2/incidentsid✅✅incidents.view
schedules/v2/schedulesid✅❌schedules.view
severities/v1/severitiesid✅❌severities.view
users/v2/usersid✅❌users.view
workflows/v2/workflowsid✅❌workflows.view

The incidents stream includes incidents in every status category, including declined, canceled and merged, which the API leaves out by default.

By default, the Incident.io API only returns standard and retrospective incidents and the records that belong to them. The incidents, actions, and follow-ups streams request every incident mode: standard, retrospective, test, tutorial, and stream. The /v2/incidents endpoint doesn't document the stream mode, so incidents contains stream incidents only if Incident.io returns them. To exclude test, tutorial, or stream incidents, filter incidents on its mode field. For actions and follow-ups, join on incident_id to incidents, then filter on mode.

The users stream includes deactivated and not-yet-active users. Use the is_active field to filter them.

The incident_alerts stream links alerts to the incidents they're attached to. Each record contains the alert, the incident, and the alert_route_id of the alert route that created the link. Use it to join the alerts stream to the incidents stream. This stream reads every link in your account, so start_date doesn't apply to it.

The alert_sources stream doesn't include each alert source's secret_token. The connector removes this field before it emits records.

The schedules stream doesn't include next_shifts. Incident.io only returns that field on pages of 25 schedules or fewer, and the connector reads larger pages.

The connector reads three streams once for each record of a parent stream:

  • catalog_entries reads the entries of each catalog type returned by catalog_types.
  • custom_field_options reads the options of each custom field returned by custom_fields.
  • incident_attachments reads the attachments of each incident returned by incidents, so it only covers incidents last updated on or after start_date.

Performance considerations​

The Incident.io API allows 1,200 requests per minute per API key, and the incidents endpoint has a lower limit of 60 requests per minute. The connector paces itself within both limits and, if the API still returns a rate-limit response, waits for the interval the API asks for before retrying.

num_workers sets how many streams and partitions the connector reads at the same time. All workers share the same rate budget, so a higher value can't exceed the limits above; it only uses more of them.

incident_attachments sends one request per incident on every sync, after re-reading the incidents endpoint from start_date at 60 requests per minute. On accounts with many incidents this stream adds significant time to each sync. If you don't need attachments, deselect the stream.

Data type map​

Integration TypeAirbyte Type
stringstring
string in RFC 3339 date-time formattimestamp_with_timezone
numbernumber
integerinteger
booleanboolean
arrayarray
objectobject

Incident.io returns timestamps as RFC 3339 strings. The connector declares them with format: date-time, so destinations that support it store them as timestamps with time zone.

Limitations & Troubleshooting​

  • Invalid API key (HTTP 401): The sync fails if the API key is invalid or has been revoked. Create a new key in Incident.io under Settings → API keys and update the source configuration.
  • Missing permission (HTTP 403): The sync fails with Incident.io's error message, which names the missing permission. Find the streams that need it in the Supported Streams table, then either edit the API key in Incident.io under Settings → API keys to add that permission, or deselect the affected streams in your connection. You don't need to create a new key or update the source configuration.
  • Transient errors (HTTP 408, 500, 502, 503, and 504): The connector retries these requests automatically.
  • Rejected requests (other HTTP 4xx, such as 400, 404, or 422): The sync fails with Incident.io's error message. The incident_attachments stream is the exception for 404; see the next item. For the full list of API error codes, see Errors in the Incident.io API reference.
  • Deleted incidents during a sync: If someone deletes an incident while incident_attachments is running, the connector skips that incident's attachments instead of failing.
  • Upgrading from 0.x to 1.0.0: Version 1.0.0 changes field types and endpoints. Follow the migration guide and refresh the source schema after upgrading.

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

Field
Type
Property name
string
api_key
integer
num_workers
string
start_date
string
time_window

Changelog​

Expand to review
VersionDatePull RequestSubject
1.0.32026-10-1689010Promote to Certified (GA)
1.0.22026-10-1588989Declare auto_run_mode, delay, folder, owning_team_ids and shortform on workflows; restructure the documentation and link to the Incident.io API reference
1.0.12026-10-1488962Declare filter_by, fixed_filter and helptext_catalog_attribute_id on custom fields; update the base image
1.0.02026-10-1488437Type timestamp fields, move catalog_types and alert_routes to /v3, sync all incident modes. See the migration guide
0.4.22026-10-1388435Declare external_issue_reference on incidents and holidays_public_config on schedules
0.4.12026-10-1388663Update dependencies
0.4.02026-10-0988418Add five alerting and escalation path streams
0.3.02026-10-0988416Add five incident and catalog streams
0.2.02026-10-0888150Migrate actions and follow-ups to /v3; add incremental sync, rate limiting, clearer errors, time_window and num_workers options, and sync incidents in every status category
0.1.422026-10-0687912Update dependencies
0.1.412026-09-2987212Update dependencies
0.1.402026-09-2286668Update dependencies
0.1.392026-09-1586108Update dependencies
0.1.382026-09-0885534Update dependencies
0.1.372026-08-1884609Update dependencies
0.1.362026-08-1183968Update dependencies
0.1.352026-08-0483515Update dependencies
0.1.342026-07-2882950Update dependencies
0.1.332026-07-2182451Update dependencies
0.1.322026-07-1481861Update dependencies
0.1.312026-06-3081093Update dependencies
0.1.302026-06-2380512Update dependencies
0.1.292026-06-1679887Update dependencies
0.1.282026-06-0979368Update dependencies
0.1.272026-06-0378426Add external_issue_reference field to the follow-ups stream
0.1.262026-06-0278742Update dependencies
0.1.252026-04-2877315Update dependencies
0.1.242026-04-2176661Update dependencies
0.1.232026-03-1775081Update dependencies
0.1.222026-03-1074503Update dependencies
0.1.212026-02-2674072Migrate to incident_roles v2 endpoint and add escalations stream
0.1.202026-02-2473520Update dependencies
0.1.192026-02-1073089Update dependencies
0.1.182026-02-0372760Update dependencies
0.1.172026-01-2071981Update dependencies
0.1.162026-01-1471413Update dependencies
0.1.152025-12-1870511Update dependencies
0.1.142025-11-2570182Update dependencies
0.1.132025-11-1869504Update dependencies
0.1.122025-10-2968778Update dependencies
0.1.112025-10-2168531Update dependencies
0.1.102025-10-1467973Update dependencies
0.1.92025-10-0767363Update dependencies
0.1.82025-09-3066802Update dependencies
0.1.72025-09-0966041Update dependencies
0.1.62025-09-0565966Update to CDK v7.0.0
0.1.52025-08-2365332Update dependencies
0.1.42025-08-0964591Update dependencies
0.1.32025-08-0264299Update dependencies
0.1.22025-07-2663825Update dependencies
0.1.12025-07-1963480Update dependencies
0.1.02025-07-1563304Add new stream alerts
0.0.292025-07-1263128Update dependencies
0.0.282025-07-0562591Update dependencies
0.0.272025-06-2862168Update dependencies
0.0.262025-06-2161830Update dependencies
0.0.252025-06-1461149Update dependencies
0.0.242025-05-2460668Update dependencies
0.0.232025-05-1059803Update dependencies
0.0.222025-05-0359231Update dependencies
0.0.212025-04-2658787Update dependencies
0.0.202025-04-1958204Update dependencies
0.0.192025-04-1257724Update dependencies
0.0.182025-04-0557094Update dependencies
0.0.172025-03-2956650Update dependencies
0.0.162025-03-2256006Update dependencies
0.0.152025-03-0855475Update dependencies
0.0.142025-03-0154780Update dependencies
0.0.132025-02-2254316Update dependencies
0.0.122025-02-1553844Update dependencies
0.0.112025-02-0853299Update dependencies
0.0.102025-02-0152718Update dependencies
0.0.92025-01-2552221Update dependencies
0.0.82025-01-1851782Update dependencies
0.0.72025-01-1151186Update dependencies
0.0.62024-12-2850648Update dependencies
0.0.52024-12-2150137Update dependencies
0.0.42024-12-1449218Update dependencies
0.0.32024-12-1148989Use a rootless Docker image (requires Airbyte 0.64 or later)
0.0.22024-11-0447842Update dependencies
0.0.12024-10-03Initial release by @aazam-gh via Connector Builder
Was this page helpful?