Skip to main content
POST
/
Error
A valid request URL is required to generate request examples
{
  "success": 1,
  "data": {
    "_id": "64a1b2c3d4e5f6a7b8c9d0e1",
    "partner_id": "64a1b2c3d4e5f6a7b8c9d0e2",
    "base_url": "https://octo.example-partner.com",
    "auth_type": "bearer",
    "handles_ticket_delivery": false,
    "isActive": true,
    "isApproved": true,
    "sync": {
      "status": "idle",
      "last_sync_at": "2026-06-23T06:00:00.000Z",
      "last_sync_hash": "a3f8c2...",
      "error_message": null
    },
    "health": {
      "status": "HEALTHY",
      "last_probe_at": "2023-11-07T05:31:56Z",
      "last_success_at": "2023-11-07T05:31:56Z",
      "consecutive_failures": 0,
      "degraded_since": "2023-11-07T05:31:56Z",
      "down_since": "2023-11-07T05:31:56Z"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

JWT issued by Seyaha — include as Authorization: Bearer <token>

Body

application/json
​
base_url
string<uri>
required

Root URL of your OCTO-compatible API endpoint (trailing slash is stripped automatically)

Example:

"https://octo.example-partner.com"

​
auth_type
enum<string>
required

How Seyaha authenticates to your OCTO endpoint

Available options:
bearer,
api_key
Example:

"bearer"

​
auth_key
string
required

The credential value — a bearer token or API key, depending on auth_type

Example:

"sk_live_abc123"

​
handles_ticket_delivery
boolean
required

Set to true if your platform delivers tickets directly to customers

Example:

false

Response

Integration created

​
success
integer
Example:

1

​
data
object