Creating API Keys and Configuring Webhooks

Open Settings > Integrations. This area requires Full Access and the relevant integration or API-key management permissions.

API Keys

API keys allow an external application to use approved integration capabilities. Key management requires its specific permission in addition to access to this Settings area.

  1. Open API Keys and select Create API Key.
  2. Enter a descriptive Key Name.
  3. Select the intended Integration.
  4. Choose the required Scopes from those available for that integration.
  5. Choose Expiration: Never expires, 30 days, 90 days, or 1 year.
  6. Create the key and securely store the value shown in the creation dialog.

Use the revoke action when a key should no longer work. Update dependent clients when replacing a key. Never include key values in support screenshots or public documentation.

Webhooks

Webhooks send event information to an external endpoint.

  1. Open Webhooks and select Add Webhook.
  2. Enter a recognizable Name and the approved Endpoint URL.
  3. Select only the Events the receiving application needs.
  4. Create the webhook and securely retain any signing information shown.
  5. Verify receipt and handling in the destination system.

Use the provided disable control to stop a webhook. The endpoint receives data outside CaseWyze, so confirm the intended destination before enabling delivery. Only event types listed in the current interface are supported.