Automation API

curl 'https://perform-api.otherwise.co.il/v1/automation/validate' \
  -H 'Authorization: Bearer YOUR_API_KEY'

{ "success": true, "message": "Trainee created", "data": { } }

{
  "success": false,
  "message": "No trainee with id cm000 exists in this studio. Use \"Search trainees\" or \"Find trainee by phone\" to get a valid id."
}

{
  "success": true,
  "message": "Connection is working",
  "data": { "studioId": "cm1s7d2kq0000jx08b4n6h1ze", "studioName": "Studio Fit", "slug": "studio-fit" }
}

{
  "id": "cm2k9x1ab0001l508u3f7q2wd",
  "name": "Noa Cohen",
  "phone": "0500000000",
  "email": "noa@example.com",
  "status": "ACTIVE",
  "coachId": "cm1c5e7gh0002",
  "planName": "3 months",
  "productId": "cm1p9k3lm0004",
  "startedOn": "2026-09-01T00:00:00.000Z",
  "endsOn": "2026-12-01T00:00:00.000Z",
  "weightKg": 71.4,
  "heightCm": 168,
  "birthDate": "1994-03-12T00:00:00.000Z",
  "gender": "FEMALE",
  "goal": "Lose 5 kg",
  "tags": ["lead", "instagram"],
  "createdAt": "2026-09-01T08:00:00.000Z",
  "updatedAt": "2026-10-07T07:15:00.000Z",
  "externalId": "sheet-row-42"
}

{
  "success": true,
  "message": "Trainee created",
  "data": {
    "trainee": { "id": "cm2k9x1ab0001l508u3f7q2wd", "name": "Noa Cohen", "phone": "0500000000", "externalId": "sheet-row-42" },
    "created": true
  }
}

{
  "success": true,
  "message": "Success",
  "data": {
    "items": [{ "id": "cm2k9x1ab0001l508u3f7q2wd", "name": "Noa Cohen", "phone": "0500000000", "externalId": null }],
    "total": 1,
    "limit": 50,
    "offset": 0,
    "hasMore": false
  }
}

{ "success": true, "message": "Trainee found", "data": { "found": true, "trainee": { "id": "cm2k9x1ab0001l508u3f7q2wd", "name": "Noa Cohen" } } }

{ "success": true, "message": "Trainee deleted", "data": { "deleted": true } }

{
  "success": true,
  "message": "Success",
  "data": {
    "items": [
      { "id": "cm1p9k3lm0004", "name": "3 months", "priceAgorot": 90000, "durationValue": 3, "durationUnit": "MONTHS", "tag": null }
    ],
    "total": 1,
    "limit": 50,
    "offset": 0,
    "hasMore": false
  }
}

{
  "success": true,
  "message": "Success",
  "data": {
    "items": [
      {
        "id": "cm2q3w7ya000al908c6t1n4xb",
        "name": "Strength block A",
        "type": "TRAINING",
        "status": "ACTIVE",
        "startsOn": "2026-09-01T00:00:00.000Z",
        "endsOn": null,
        "sourceTemplateId": "cm1t1m5no0006",
        "createdAt": "2026-09-01T08:00:00.000Z"
      }
    ]
  }
}

{
  "success": true,
  "message": "Signing link created",
  "data": {
    "assignment": {
      "id": "cm3a1s4de000vl908e9z2f6aw",
      "formTemplateId": "cm1f3a2bc0007",
      "clientId": "cm2k9x1ab0001l508u3f7q2wd",
      "status": "PENDING",
      "signingUrl": "https://app.byperform.co.il/sign/YOUR_SIGNING_TOKEN"
    },
    "signingUrl": "https://app.byperform.co.il/sign/YOUR_SIGNING_TOKEN"
  }
}

{
  "success": true,
  "message": "Success",
  "data": {
    "items": [
      {
        "id": "cm3b3u6ef000xl908g1b4h8cy",
        "submittedAt": "2026-10-05T07:00:00.000Z",
        "formTemplate": { "id": "cm1f3a2bc0005", "name": "Weekly check-in", "type": "CHECK_IN" }
      }
    ]
  }
}

{
  "success": true,
  "message": "Weight logged",
  "data": { "entry": { "id": "cm2u4d8xf000jl908r6m2t5wn", "weightKg": 71.4, "recordedAt": "2026-10-07T05:41:00.000Z", "source": "automation" } }
}

{
  "success": true,
  "message": "Success",
  "data": {
    "items": [
      {
        "id": "cm3g3e6jk0017l908q1l4r8mi",
        "title": "Call about renewal",
        "detail": null,
        "status": "OPEN",
        "priority": 1,
        "dueAt": "2026-10-10T07:00:00.000Z",
        "clientId": "cm2k9x1ab0001l508u3f7q2wd",
        "coachId": "cm1c5e7gh0002",
        "createdAt": "2026-10-07T12:00:00.000Z"
      }
    ],
    "total": 1,
    "limit": 50,
    "offset": 0,
    "hasMore": false
  }
}

{
  "success": true,
  "message": "Webhook registered",
  "data": {
    "hook": {
      "id": "cm3i7i0lm001bl908u5p8v2qm",
      "event": "FORM_FILLED",
      "targetUrl": "https://hooks.example.com/perform/form-filled",
      "formTemplateId": null,
      "active": true,
      "createdAt": "2026-10-07T12:30:00.000Z",
      "lastDeliveryAt": null,
      "lastStatus": null,
      "secret": "YOUR_WEBHOOK_SECRET"
    }
  }
}

{ "success": true, "message": "Webhook removed", "data": { "deleted": true } }

import { createHmac, timingSafeEqual } from 'node:crypto';

function verify(rawBody: Buffer, header: string, secret: string): boolean {
  const expected = `sha256=${createHmac('sha256', secret).update(rawBody).digest('hex')}`;
  const a = Buffer.from(header);
  const b = Buffer.from(expected);
  return a.length === b.length && timingSafeEqual(a, b);
}

{
  "event": "form_filled",
  "occurredAt": "2026-10-07T07:15:00.000Z",
  "studioId": "cm1s7d2kq0000jx08b4n6h1ze",
  "submissionNumber": 6,
  "formType": "CHECK_IN",
  "documentUrl": null,
  "form": { "id": "cm1f3a2bc0005", "name": "Weekly check-in", "type": "CHECK_IN" },
  "trainee": {
    "id": "cm2k9x1ab0001l508u3f7q2wd",
    "name": "Noa Cohen",
    "firstName": "Noa",
    "lastName": "Cohen",
    "phone": "0500000000",
    "email": "noa@example.com",
    "externalId": "sheet-row-42"
  },
  "response": {
    "id": "cm3b3u6ef000xl908g1b4h8cy",
    "assignmentId": "cm3a1s4de000vl908e9z2f6aw",
    "formVersion": 3,
    "submittedAt": "2026-10-07T07:15:00.000Z",
    "answers": { "weight": 71.4, "energy": 4 },
    "fields": [
      { "key": "weight", "label": "Current weight", "type": "weight", "value": 71.4 },
      { "key": "energy", "label": "Energy this week", "type": "rating", "value": 4 }
    ]
  }
}

{
  "success": true,
  "message": "Success",
  "data": [
    { "id": "cm1p9k3lm0004", "value": "3 months · ₪900" }
  ]
}

{
  "success": true,
  "message": "Success",
  "data": [
    { "value": "price", "label": "Monthly price (price)" }
  ]
}