Connect Corteksa to your systems: the developer guide
Outside systems integrate with Corteksa in 2 directions: they pull and write records through the REST API with an API key or an OAuth token, and Corteksa pushes changes to them through signed Webhooks.
The 2 directions
2 ways to connect
crtk_live_crtk_oauth_The core principle
A key or token works with the permissions of the member who created it, within the scopes chosen. Every request goes through 2 checks: does the scope allow this action? And does the member’s current level allow this record? See Key scopes, and how they combine with permissions.
Every developer guide
/meWhat no key can reach
Members, roles, billing, workspace settings, the structure of units and fields, duplicate rules, and managing keys and apps themselves. These are for people only.
A key works with its creator’s permissions. Keep it in a secrets vault on the server, and never put it in front-end code, a mobile app, a public repository or system logs.
A real example
The academy’s website collects registration requests, and wants to send them to Corteksa and receive status updates.
- The developer created a key with the Write scope on the “Leads” unit. See Create and revoke an API key.
- The website creates a record for each request through the API.
- The developer subscribed to
record.updatedto receive status changes. See Subscribe to Webhooks to receive record changes.
Every request shows in Corteksa within seconds, and the website shows each student the status of their request.