Prism Connect — How to Setup in the Client portal
Generating an API key and setting up webhooks. Performed in your Prism portal (trainer/syndicator account).
Prism Connect lets you connect external systems to Prism via an API key and webhooks. Your Prism administrator must first enable Connect and grant module access for your account — after that, you can generate your credentials as described below.
1. Open the Integration page
- Click your profile name/avatar (top-right).
- Go to Utilities → Integration.
- The Integration page has three tabs: API key, Webhook, History.
2. Generate your API key
- On the API key tab, click + Generate API key.
- The "Save your API key" dialog displays your key (e.g.
pc_live_…).
⚠️ This is the only time the key is shown. Copy it (copy icon) and store it securely — once the dialog closes, the secret is masked. If you lose it, rotate the key to get a new one.
- The key now appears as ACTIVE, with Rotate (replace with a new secret) and Revoke (disable it) actions, plus Created / Last used info.
3. Authenticate API requests
- Send your key in the
X-API-KEYheader when calling the Prism Connect API. - The "Your API access" panel lists exactly which modules you can Read or Read/Write. Permissions are managed by Prism (your account's module grants), and generating a key does not grant new access. Contact support to change permissions.
4. Create a webhook
- Switch to the Webhook tab and click Create webhook.
- Endpoint: enter your Destination URL — it must use
https://and will be verified via a handshake after the webhook is created. - Signing secret: generated when the webhook is created and shown once — copy it to verify the signed JSON payloads Prism POSTs to you.
- Events: subscribe per module — Prism delivers every event published for that module (created, updated, deleted, etc.). Use the
event.typefield in the payload to route events on your side.
Quick Reference
| Task | Action |
|---|---|
| Generate API key | Profile → Utilities → Integration → API key → Generate API key → copy → Done |
| Replace a lost/compromised key | Integration → API key → Rotate (or Revoke) |
| Receive live events | Integration → Webhook → Create webhook (HTTPS URL + signing secret) |
Related Articles
ATA PORTAL
Overview The ATA Hub connects ATA admins with Prism trainers (referred to as "Owners" in the ATA portal) through two main channels: Public Announcements: Website articles visible to everyone Private Communications: Stable Updates visible only to ATA ...[Supplier Portal] How to share Vet note to Trainer of the shared horse
A new permission called “Vet Note” is introduced, configured separately for each portal (e.g., Supplier portal). If a horse is shared from a Trainer: When this permission is enabled, the “Enable this option to share your comments directly with the ...How to manage Prism Plus
On this page Prism Plus - Horses Prism Plus - Communications Prism Plus - Analytical Dashboards You must be logged in as your Prism Master Admin you account to access these dashboards Prism Plus is used to quickly consolidate tasks and notes related ...[Supplier Portal] How to apply Adjustment Date for the shared ownerships
If a horse is shared from a Trainer: When the Supplier accepts, on the Share Horse Ownership popup, add a new field Adjustment Date with the tooltip: “Adjustment Date is the Date of Sale. Purchase and billing for the new owner will start from the ...How to invoice stallion service fees
There are two methods to invoice mare owners the service fee for each stallion booking. Create Service Fee transaction upon milestone completion Manually create Service Fee transaction These Service Fee transactions can then be automatically included ...