Integration self-service

What an integration can call about itself: its registration, config, heartbeat and log.

Only integration keys can call these. A typical integration reads its config at start-up, sends a heartbeat after every sync, and logs notable events:

POST /api/v1/integrations/self/health
{ "status": "ok", "message": "Last sync 12:05" }

status is ok, warning or error. Log levels are debug, info (default), warning and error. See Build an integration.

All paths are relative to /api/v1. Key is the scope an integration key needs, People the permission a signed-in person or personal key needs, and Feature the feature switch the endpoint belongs to. See how to read this reference.

GET/integrations/self
The calling integration's registration
Keyintegration key
Peoplenot allowed
GET/integrations/self/config
Config values entered by the admin
Keyintegration key
Peoplenot allowed
POST/integrations/self/health
Send a heartbeat and status message
Keyintegration key
Peoplenot allowed
POST/integrations/self/logs
Add a log message to the integration's log
Keyintegration key
Peoplenot allowed