API keys, OAuth and webhooks

Choose the integration mechanismCopy Anchor Link

Workspace settings separate API Keys, OAuth clients and Webhooks. API credentials allow an integrating system to request permitted operations. Webhooks send subscribed event notifications to your configured endpoint. Use the credential type your integration supports.

Create an API keyCopy Anchor Link

1. Open API Keys → Create API Key.
2. Enter a name that identifies the consuming system and purpose.
3. Select the required scopes. Groups offer Select all or Deselect group; review the selected count and each write or filing scope carefully.
4. Review Set Expiration and the displayed duration.
5. Choose Create Key, then follow the credential display and storage instructions shown by the platform.

ARCA Monitor

The key list provides status and Enable/Disable and Delete actions. Disabling or deleting a key can interrupt its consuming integration. Coordinate the replacement and verify the integration's result. A key prefix identifies a credential; it is not the complete key.

Create an OAuth clientCopy Anchor Link

1. Open OAuth clients → Create OAuth client.
2. Enter a name and description for one integrating system.
3. Select the required scopes; the client does not need every scope by default.
4. Review Access token lifetime, expressed in minutes.
5. Create the client and transfer the displayed credentials using your organization's approved secret-management process.

ARCA Monitor

The client list offers Rotate secret and Revoke. Coordinate rotation with the consuming system and read the confirmation. Revocation removes the client's ability to obtain access as described by the platform; do not use it as a way to refresh a page. The integration guide on the page includes the token endpoint, public-key endpoint, server metadata and workspace code.

Add a webhookCopy Anchor Link

1. Open Webhooks → Add Webhook.
2. Enter a descriptive name and the endpoint URL supplied by your integration team.
3. Select only the events the receiver handles. The form groups ingestion, transactions, alerts, cases, screening and subscription/payment events.
4. Create the webhook and configure the receiver with the signing information shown by the platform.
5. When ready, use Test and inspect the delivery result. A saved configuration alone does not establish successful delivery.

ARCA Monitor

The action menu offers secret rotation, enable/disable and deletion. A test sends a request to the configured endpoint; arrange the test with its owner. When changing the signing secret, update the receiver as part of the same coordinated change.

Verify the outcomeCopy Anchor Link

Confirm the workspace, credential or endpoint name, status, selected scopes/events and the consuming system's result. Keep operational secrets in your approved secret store. Screenshots in this guide intentionally show empty creation forms, so no existing credentials are needed to follow the procedure.