Partner Event API

Partner Event API

Version: 1.0 Document Version: v0.8 Last Updated: 2026-01-15

Overview

The Partner Event API is designed to allow partners to send event data (alarms, troubles, arming status) to the CHeKT cloud in real-time. This API is separate from the Partner API and focuses specifically on event ingestion and media upload.

Authentication

The Partner Event API uses OAuth 2.0 Client Credentials Grant with JWT assertions for M2M (Machine-to-Machine) authentication.

Quick Start

1. Register an Auth Application with CHeKT support
2. Generate a JWT assertion signed with your M2M secret key
3. Exchange the assertion for an access token
4. Include the token in API request headers:

Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

API Endpoint

Send Event

POST /partner/v1/events

Sends event data from OpenEye platform to CHeKT cloud.

Request Headers:

Content-Type: application/json
X-API-KEY: {your-api-key}

Request Body:

{
  "version": "1.0",
  "location_id": "Z6RSOG",
  "recorder_id": "Z6RANV",
  "camera_id": "2fe519b4-2438-4aa1-b051-87cf22bb",
  "event_id": "1763603245534315",
  "event_type": "alarm",
  "event_status": "active",
  "event_time": "2025-11-20T01:46:25.534Z",
  "sent_at": "2025-11-20T01:46:28.534Z",
  "should_signal_to_monitoring_center": true,
  "upload_snapshot_count": 1,
  "upload_short_mp4": false,
  "upload_event_mp4": true,
  "payload": {}
}

Request Body Parameters:

Response Format

Success Response (201 Created)

{
  "event_id": "eve-56",
  "response_id": "019a338f-5581-7368-b166-b4235f6f4750",
  "uploads": {
    "snapshots": [
      {
        "seq": 0,
        "upload_put_url": "https://my-example-bucket.s3.us-east-1.amazonaws.com/device/123/snapshot_0.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256",
        "callback_put_url": "https://api.chektdev.com/partner/v1/events/eve-56/uploads/callback?seq=0&type=snapshot&access_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
      },
      {
        "seq": 1,
        "upload_put_url": "https://my-example-bucket.s3.us-east-1.amazonaws.com/device/123/snapshot_1.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256",
        "callback_put_url": "https://api.chektdev.com/partner/v1/events/eve-56/uploads/callback?seq=1&type=snapshot&access_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
      }
    ],
    "short_mp4": {
      "upload_put_url": "https://my-example-bucket.s3.us-east-1.amazonaws.com/device/123/short_mp4.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256",
      "callback_put_url": "https://api.chektdev.com/partner/v1/events/eve-56/uploads/callback?type=short_mp4&access_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
    },
    "event_mp4": {
      "upload_put_url": "https://my-example-bucket.s3.us-east-1.amazonaws.com/device/123/event_mp4.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256",
      "callback_put_url": "https://api.chektdev.com/partner/v1/events/eve-56/uploads/callback?type=event_mp4&access_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
    }
  },
  "status": "accepted",
  "reason": null
}

Response Parameters:

Upload URLs

Each upload object contains:

• upload_put_url: Pre-signed S3 URL for uploading the media file
• callback_put_url: Callback URL to notify CHeKT after upload completion

Error Responses

400 Bad Request

{
  "error": "Bad Request",
  "message": "Invalid input or params"
}

401 Unauthorized

{
  "error": "Unauthorized",
  "message": "Invalid token or credentials"
}

403 Forbidden

{
  "error": "Forbidden",
  "message": "Access denied"
}

404 Not Found

{
  "error": "Not Found",
  "message": "Resource does not exist"
}

Event Types

The API supports the following event types:

Upload Workflow

1. Send Event: POST event data to /partner/v1/events
2. Receive URLs: Get pre-signed upload URLs in response
3. Upload Media: Upload snapshots/videos to the provided S3 URLs using PUT requests
4. Send Callback: After each successful upload, call the callback_put_url to notify CHeKT

Version History

Next Steps