Integrations
Connect a trusted website to groups and leads.
Use an integration when your existing website needs to show available groups or pass on an enquiry. These calls must come from your website's server. A key in browser code would be visible to visitors.
An organization owner creates the key in Settings → API access:
- Give the key a name that tells you which website uses it. Choose only the permissions needed for the tasks below, then select Create API key.
- Copy the key when it appears and save it in your server's secret settings. Taskpipe shows the full key only when you create it.
- Send a test request from your server with the key in the
x-api-keyheader. Check the response before connecting a live form.
The API reference gives the paths, request fields, responses and errors. These calls do not give access to private manager or student routes.
Students enrol through the Taskpipe course page. Owners and managers can also add a student at no charge.
Choose permissions
| Task | Permission |
|---|---|
| List groups | modality:read |
| Capture a lead | lead:write |
When the website stops using a key, revoke it in Settings → API access and remove it from the server. Requests with that key will then fail, so replace it on any server that still needs access first.