API Endpoints
Management API Endpoints
All integration configuration and monitoring is available through the Management API. These endpoints let you list available connectors, activate integrations, monitor events, and trigger retries.
Integration configuration
List available integrations
Returns the full catalogue of available integration manifests, including settings schemas and sync events.
GET /v1/integrations/available
Authorization: Bearer <token>
Get all integrations
Returns all integrations configured for the current tenant.
GET /v1/integrations/
Authorization: Bearer <token>
Search integrations
GET /v1/integrations/search?q=klaviyo
Authorization: Bearer <token>
Create integration
POST /v1/integrations/
Authorization: Bearer <token>
Content-Type: application/json
{
"service": "klaviyo",
"enabled": true,
"name": "Klaviyo Marketing",
"settings": {
"apiKey": "pk_xxx..."
},
"synchronizations": [
{ "eventType": "order.created", "enabled": true },
{ "eventType": "order.updated", "enabled": true }
]
}
Get specific integration
GET /v1/integrations/{integrationId}
Authorization: Bearer <token>
Update integration
PUT /v1/integrations/{integrationId}
Authorization: Bearer <token>
Content-Type: application/json
{
"enabled": false,
"settings": { ... }
}
Delete integration
DELETE /v1/integrations/{integrationId}
Authorization: Bearer <token>
Regenerate API key
For custom integrations — regenerates the inbound API key. The previous key is immediately invalidated.
POST /v1/integrations/{integrationId}/regenerate-key
Authorization: Bearer <token>
Trigger sync
Manually trigger a synchronization for an integration.
POST /v1/integrations/{integrationId}/sync
Authorization: Bearer <token>
Event monitoring
Filter events
Query integration events with filtering by integration, status, date range, and more.
POST /v1/integrations/events/filter
Authorization: Bearer <token>
Content-Type: application/json
{
"integrationId": "integration-id",
"status": "failed",
"from": "2025-01-01T00:00:00Z",
"to": "2025-01-31T23:59:59Z",
"page": 1,
"limit": 50
}
Get event by ID
Returns the full event detail including communication logs and payload references.
GET /v1/integrations/events/{eventId}
Authorization: Bearer <token>
Retry event
Manually resubmit a failed event. Creates a new event linked to the original and enqueues it immediately.
POST /v1/integrations/events/{eventId}/retry
Authorization: Bearer <token>
Cancel event
Cancel a queued or stuck event to prevent further processing.
POST /v1/integrations/events/{eventId}/cancel
Authorization: Bearer <token>