Create Integration

Create a new integration row.

Slug is derived from name and made unique with numeric suffixes on collision. Empty post normalization slug returns 422.

POST /admin/api/v1/integrations

Create Integration

cURL

curl --request POST \
  --url https://api.example.com/admin/api/v1/integrations \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "integration": {
    "config": {
      "accessToken": "<string>",
      "phoneNumberId": "<string>",
      "verifyToken": "<string>",
      "apiVersion": "v21.0"
    },
    "enabled": true
  },
  "enabled": true
}
'

201

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "name": "<string>",
    "enabled": true,
    "integration": {
      "config": {
        "accessToken": "<string>",
        "phoneNumberId": "<string>",
        "verifyToken": "<string>",
        "apiVersion": "v21.0"
      },
      "enabled": true
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "reload": {
    "message": "<string>",
    "error": "<string>"
  }
}

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.

Show child attributes

enabled · boolean · default: true

Response

201

application/json

Successful Response

data · StandaloneIntegrationRead · object · required

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

Show child attributes

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.

Show child attributes