Integrations & API Keys

You manage integrations and API keys from your organization’s Settings page. Integrations are on the Integrations tab. API keys are on the API Keys tab.

Integrations

Integrations connect Aperture to external services so that alerts and notifications can reach your team outside the app. An integration belongs to one workspace, not to the organization as a whole. If your organization has more than one workspace, each workspace has its own separate list of integrations. This holds even though the Integrations tab is under Organization Settings.

Use the Workspace selector at the top of the tab to choose which workspace’s integrations you are managing. It lists the organization’s active workspaces. If the organization has only one, Aperture selects it for you. Until a workspace is selected, the list is empty and Add Integration is disabled.

Slack is currently the only supported integration type.

Adding a Slack integration

1. Go to Settings → Integrations, choose a Workspace, and click Add Integration.
2. Enter a descriptive Name. The default is “Slack Integration”.
3. Paste your Webhook URL. This is the Incoming Webhook URL from your Slack app configuration. This field is required, and Save and Test Connection stay disabled until you enter it.
4. Optionally enter a Channel, for example #pricing-alerts, to override the channel the webhook posts to by default. Leave it blank to use the channel configured in Slack.
5. Leave Enable this integration checked to activate it.
6. Click Test Connection to send a test message with the webhook URL you entered. This confirms the webhook works before you save.
7. Click Save.

The integration appears in the list with its name, type, configured channel if one is set, and an Enabled or Disabled status badge.

Tip

Test Connection posts a test message using the webhook URL you entered. The dialog shows a success message, or the error Slack returns if the request fails, so you can confirm the webhook works before saving.

For the end-to-end flow from connecting Slack through to an alert event arriving in a channel, see Delivering Alerts to Slack.

Editing an integration

Click the pencil edit icon on any row to reopen the configuration dialog. You can update the name, webhook URL, channel, or enabled setting. Click Save to apply the changes.

If you clear Enable this integration and one or more alert rules currently post to it, the dialog shows how many and explains that disabling does not change those rules. They stay enabled, keep creating alerts in the inbox, and keep sending email notifications if that delivery is already configured. They simply stop posting to Slack until you enable the integration again.

Deleting an integration

Click the trash delete icon on any row. A confirmation dialog appears before the integration is permanently removed. This cannot be undone.

Caution

If one or more alert rules currently post to this Slack integration, the confirmation dialog tells you how many. After you delete it, those rules stop posting to Slack but stay enabled: they keep creating alerts in the inbox, and keep sending email notifications if that delivery is already configured. Rules that only used Slack keep creating alerts in the inbox.

---

API keys

API keys let you authenticate requests to the Aperture API from scripts, pipelines, or other services without your personal login session. API keys belong to an organization. The API Keys tab lists, creates, and revokes keys for the organization whose Settings page you currently have open. Any key that any member creates appears in that same list, and everyone with access to the organization’s Settings can see it. Each key operates with the access level of the person who created it, within the organization the key belongs to. Managing keys always requires your own signed-in session; a request authenticated with an API key cannot create, list, or revoke keys.

Creating an API key

1. Go to Settings → API Keys and click Create API Key.
2. Enter a descriptive Key Name that identifies where you will use the key, for example “CI/CD Pipeline” or “Production Export”.
3. Choose an Expiration:
   • Never. The key does not expire. This is the default.
   • 30 days, 90 days, or 1 year. The key becomes invalid after the chosen period.
4. Click Create Key.

A dialog then displays the full API key. Copy and store it immediately. The complete key value is shown only once and cannot be retrieved again. Click I’ve Saved My Key to close the dialog.

Caution

Store your API key in a secure location, such as a secrets manager or an environment variable. If you lose it, you will need to create a new one. Never commit a key to version control.

Using an API key

Send the key in the Authorization header of every request:

Authorization: Bearer peg_<your-key>

All API keys begin with the peg_ prefix. Aperture authenticates a request sent with a key as the account that created the key.

Unlike your logged-in session, an API key is not tied to a specific workspace. To reach workspace-scoped areas of the API, such as products, alerts, and integrations, add an X-Tenant-ID header with the ID of a workspace in the key’s organization:

X-Tenant-ID: <workspace-id>

Caution

A key can only use workspaces in its own organization. Naming a workspace from another organization, even one you belong to, is rejected. A request to a workspace-scoped area without the header has no workspace and fails.

Viewing your keys

The API Keys tab lists every API key created for the organization, not only the ones you created yourself. For each key you can see:

Column	What it shows
Name	The label given to the key when it was created
Prefix	A short identifier, for example peg_abc123.... It is safe to share for identification
Last Used	When the key was last used to authenticate a request, or “Never used”
Expires	The expiration date, Expired if the date has passed, or Never
Status	Active or Revoked

Revoked keys remain visible in the list with a Revoked status so you have a record of past keys.

Revoking an API key

Click Revoke on any active key, including keys that other members of your organization created. A confirmation dialog warns that any application using that key will immediately lose access. Revocation is permanent and cannot be undone.

Keys are also revoked automatically when their creator is removed from the organization or leaves it.

Tip

Periodically review the Last Used column to spot keys that are no longer needed and revoke them. Separate keys per service or environment let you revoke access selectively without disrupting other integrations.