Integrations | PurrOS Docs

Registering and managing integrations: manifests, config, keys, logs and ingestion batches.

Managing integrations is for people only, with integrations.manage at reach Everyone. The API key and webhook secret returned at registration are shown once. See Integrations.

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
List integrations; status filters
Keynot allowed
Peopleintegrations.manage (Everyone)
POST/integrations
Register an integration from its manifest; returns its API key and webhook secret once
Keynot allowed
Peopleintegrations.manage (Everyone)
GET/integrations/{id}
An integration with its manifest, config (secrets masked), API keys and webhook endpoints
Keynot allowed
Peopleintegrations.manage (Everyone)
DELETE/integrations/{id}
Remove an integration with its keys, config, logs and webhook endpoint
Keynot allowed
Peopleintegrations.manage (Everyone)
PUT/integrations/{id}/manifest
Replace its manifest, e.g. for a new version
Keynot allowed
Peopleintegrations.manage (Everyone)
PATCH/integrations/{id}/config
Change config values (null removes one)
Keynot allowed
Peopleintegrations.manage (Everyone)
POST/integrations/{id}:pause
Pause it: its keys are refused and its webhooks wait
Keynot allowed
Peopleintegrations.manage (Everyone)
POST/integrations/{id}:resume
Resume it
Keynot allowed
Peopleintegrations.manage (Everyone)
POST/integrations/{id}:rotate-key
Issue a new API key; the old ones keep working for graceMinutes
Keynot allowed
Peopleintegrations.manage (Everyone)
GET/integrations/{id}/logs
Messages it logged; level and from filter
Keynot allowed
Peopleintegrations.manage (Everyone)
GET/integrations/{id}/batches
Ingestion batches it sent, with created, updated and rejected counts; from and rejectedOnly filter
Keynot allowed
Peopleintegrations.manage (Everyone)