Skip to main content
POST
Create Integration

Body

application/json

Body for POST /admin/api/v1/integrations.

name
string
required
integration
IntegrationConfig · object
required

Top-level integration configuration.

Each integration binds an external messaging provider to the agent. When the engine starts, it registers webhook endpoints for each enabled integration.

enabled
boolean
default:true

Response

Successful Response

data
StandaloneIntegrationRead · object
required

GET response and the data payload of POST/PATCH/DELETE responses.

reload
StandaloneReloadResult · object
required

Reload outcome attached to every admin mutation response.

reloaded means DB committed and runtime now uses the new config. restart_required means DB committed and process restart is needed. reload_failed means DB rolled back and runtime is unchanged.

Last modified on May 22, 2026