API Keys & Webhooks

Last updated: 16 April 2026

API Keys & Webhooks

The Developers section lets you create API keys for programmatic access to Jump and set up webhooks to receive real-time notifications when events occur.

How to Get There

Navigate to Settings > Developers.

API Keys

API keys allow external systems to access your Jump data programmatically.

Creating an API key:

  1. Click Create API Key
  2. Enter a descriptive name (e.g. "Production Server", "Integration Service")
  3. Select the mode:
    • Test - for development and sandbox testing
    • Live - for production use with real patient data
  4. Select permissions - choose which data the key can access:
    • Clinical Data: patients, consultations, problems, appointments, documents, prescriptions
    • Read-only options: appointment types, clinicians, locations, availability
    • Write access: holds (for booking integrations)
  5. Click Create

The full API key is shown once after creation. Copy and store it securely - it cannot be retrieved again.

Using the key: Include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Rate limit: 1,000 requests per hour (contact support to increase).

Revoking a key: Click the revoke action on any active key. This takes effect immediately and cannot be undone.

Webhooks

Webhooks send real-time HTTP POST notifications to your server when events occur in Jump.

Creating a webhook:

  1. Click Create Webhook
  2. Enter the endpoint URL (must be HTTPS)
  3. Optionally add a name for easy identification
  4. Select the events to subscribe to:
    • Appointments - created, updated, cancelled, rescheduled, completed
    • Patients - created, updated
    • Documents - created, updated
  5. Click Create

A signing secret is shown once after creation. Use this to verify webhook signatures and ensure requests are genuinely from Jump.

Verifying signatures: Each webhook includes an X-Webhook-Signature header containing an HMAC-SHA256 signature of timestamp.payload using your signing secret.

Delivery and retries: Failed deliveries are retried up to 5 times with exponential backoff. The delivery log shows the status of each attempt.

Managing webhooks:

  • Send test - deliver a test event to verify your endpoint is working
  • Pause/Activate - temporarily stop deliveries without deleting the webhook
  • View delivery log - see delivery history with status codes and timestamps

Tip: Start with test-mode API keys and the "Send test" webhook feature to validate your integration before going live.