Developers

# Your retention signals, in your own systems

A REST API to read and change your companies, employees, risk changes and competitors - and webhooks that push employee warnings and poaching opportunities to you the moment they are detected.

[Read the API reference](https://www.teampredict.ai/developers/api)[Webhooks guide](https://www.teampredict.ai/developers/webhooks)

Quickstart

```
curl https://app.teampredict.ai/api/v1/employees \  -H "Authorization: Bearer tp_your_api_key"
```

Create an API key in the dashboard under Settings → Developers (admins only). Keys are read-only unless you grant write access, and are shown once.

REST API

## Everything the dashboard does

-   Every tracked employee with their latest risk level and profile signals
-   The full feed of detected profile changes, filterable by risk score and date
-   Per-employee change history, exactly as the dashboard shows it
-   Tracked competitors and their people, scored as poaching opportunities
-   Write too: add or remove people and competitors, and manage your webhooks

[Explore the API reference →](https://www.teampredict.ai/developers/api)

Webhooks

## Get pushed the moment something changes

-   Employee warnings the moment a risky change on your roster is detected
-   Poaching opportunities when someone at a tracked competitor looks open to a move
-   A 5-level sensitivity slider per event type, per endpoint
-   HMAC-signed payloads, automatic retries, and a delivery log in the dashboard

[Read the webhooks guide →](https://www.teampredict.ai/developers/webhooks)

Example event

## One JSON payload, everything you need to act

Every webhook delivery carries the employee, the detected change, the AI risk score and the plain-English summary behind it - enough to post a useful Slack message or open a task without a follow-up API call. The same shape powers both employee warnings and poaching opportunities, so one receiver handles both.

Choose how much you hear with the sensitivity slider: five levels per event type, from Critical only (90%+ risk) to Every signal (20%+). Departures always come through.

employee.warning

```
{  "id": "evt_18342_7",  "type": "employee.warning",  "createdAt": "2026-07-27T09:14:02.511Z",  "sensitivityLevel": 3,  "organization": { "id": 7, "name": "Acme Robotics" },  "data": {    "employee": { "id": 123, "name": "Jordan Lee", "title": "Staff Engineer" },    "change": {      "changeType": "open_to_work",      "riskScore": 0.82,      "riskLevel": "high",      "summary": "Turned on Open to Work and rewrote their headline."    }  }}
```

## Developer FAQ

### What can I build with the TeamPredict API?

Anything that needs your retention and poaching signals where your team already works: pipe risk changes into Slack or Microsoft Teams, sync flagged employees into your ATS or CRM, feed poaching opportunities to your recruiting pipeline, build internal dashboards, or archive change history in your warehouse. You can also write: have your HRIS add every new hire to tracking automatically, and untrack leavers the day they go.

### Can the API change things, or only read them?

Both, and you choose per key. Every key can read; only a key an admin creates with write access can add or remove people, competitors and webhooks, so a leaked read key cannot change anything or spend a cent. Write keys cannot run up a bill either: added seats are charged to your card in batches of ten, so no more than about $50 of additions is ever unbilled, and if that charge is declined no further people can be added until the card is fixed. A company still on the free trial can never track more than 100 people at all.

### How do webhooks decide what to send?

Each webhook endpoint has two event types - employee warnings for your own roster and poaching opportunities for tracked competitors - and each has its own sensitivity slider with five levels, from Critical only (90%+ risk) to Every signal (20%+). Departures are always delivered. Pick a level per endpoint, so a pager integration can stay quiet while a data warehouse hears everything.

### How are webhook deliveries secured?

Every delivery is an HTTPS POST signed with your endpoint's secret using HMAC-SHA256, sent in the X-TeamPredict-Signature header. Verify the signature and timestamp before trusting a payload. Failed deliveries retry on a backoff schedule for about a day and a half, and an endpoint that keeps failing is disabled automatically so you can fix and re-enable it.

### Do the API and webhooks cost extra?

No. They are included with every TeamPredict subscription and during the free trial. Rate limits apply (120 requests per minute per key), and access pauses if the subscription lapses.

## Start building in minutes

The API and webhooks are included with every plan and during the free trial. Sign up, add your team, and create a key.

[Start Your Free Trial](https://app.teampredict.ai/signup)
