Skip to main content

Authorization

Follow this guide to create a new incident.io credential that will allow Nexla to authenticate to and exchange data with your incident.io account.
incident_io_api_auth.png

incident.io

Prerequisites​

To connect Nexla to incident.io, you need an incident.io API key. incident.io authenticates all API requests using Bearer token authentication, where the API key is transmitted as a Bearer token in the Authorization request header. API keys are scoped to your incident.io organization and can be granted account-level permissions, team-scoped permissions, or a combination of both.

Only users with the api_keys_manage permission can create API keys. This permission must be granted from the incident.io dashboard and cannot be assigned via the API itself.

Obtain an incident.io API Key​

incident.io API keys are generated from the Settings area of the incident.io application.

  1. Log in to your incident.io account at app.incident.io.

  2. Navigate to Settings in the left-hand navigation panel.

  3. Select API keys from the Settings menu.

  4. Click the Create API key button.

  5. Enter a descriptive Name for the key (for example, Nexla Integration) to help identify its purpose later.

  6. Select the permissions (roles) that this key should have. incident.io API keys can be granted account-level permissions, team-scoped permissions, or both. Select the permissions appropriate for the data you want Nexla to access:

    • Account-level permissions apply to all data in your incident.io organization.

    • Team-scoped permissions restrict the key's access to specific teams and their associated incidents, schedules, and alerts.

    Choose the minimum permissions required for your Nexla integration. For read-only data ingestion, select only read permissions. For writing data back to incident.io (for example, creating incidents), include the relevant write permissions. You can edit the permissions on an existing key if your requirements change—there is no need to delete and recreate it.

  7. Click Create to generate the key.

  8. On the confirmation screen, copy the API key and store it in a secure location.

Important

The API key is displayed only once immediately after creation. If you navigate away without copying it, you will need to create a new key. Store the key in a secrets manager or other secure credential store. API keys remain valid even if the user who created them is later deactivated.

The default rate limit for the incident.io API is 1,200 requests per minute per API key. For complete details about API key management, permissions, and rate limits, refer to the incident.io API Reference.

Create an incident.io Credential​

  • To create a new incident.io credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

incident.io authenticates all API requests using a Bearer token transmitted in the Authorization request header. Nexla sends this header automatically once the API key is saved in the credential.

  1. Enter your incident.io API key in the API Key Value field. This is the token you copied when creating the key in Settings > API keys within incident.io.

    The API key value is stored securely and is not displayed after the credential is saved. Nexla uses this key to authenticate all requests to the incident.io API on your behalf.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.