Hamla

Hamla API

Hamla API as documented publicly: 5 operations. Contract generated from the documentation by API Evangelist (2026-11-11); not the provider's own document.

Documentation GitHub OpenAPI

Operations 5

POST /api/install POST /api/install #

POST /api/sdk/identify POST /api/sdk/identify #

POST /api/sdk/track POST /api/sdk/track #

POST /api/sdk/track/batch POST /api/sdk/track/batch #

GET /developers.md Retrieve the developers markdown page. #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/hamla-io/openapi/_ae-authored/hamla-io-openapi-generated.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/hamla-io/json-schema/hamla-io-post-api-sdk-track-request-schema.json

📊

JSONSchema

https://artifacts.apis.io/hamla-io/json-schema/hamla-io-post-api-sdk-track-batch-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/hamla-io/json-schema/hamla-io-post-api-sdk-track-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/hamla-io/json-schema/hamla-io-post-api-sdk-track-batch-request-schema.json

📊

JSONSchema

https://artifacts.apis.io/hamla-io/json-schema/hamla-io-post-api-install-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/hamla-io/json-schema/hamla-io-post-api-sdk-identify-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hamla-io:hamla-io-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Hamla API
  version: '2026-11-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-11: 5 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Hamla has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 1
    pages-with-code: 3
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.hamla.io/reference/events
  - https://docs.hamla.io/reference/events.md
  - https://www.hamla.io/en/developers
servers:
- url: https://app.hamla.io
paths:
  /api/install:
    post:
      operationId: post_api_install
      tags:
      - Api
      summary: POST /api/install
      x-source: https://www.hamla.io/en/developers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiInstallRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiInstallResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://app.hamla.io/api/install  -H \"Content-Type: application/json\"  -d '{\n \"website\": \"raqmi.co\",\n \"\
          name\": \"Raqmi\",\n \"locale\": \"en\"\n }' Five installs per hour per IP address. 2 Put the snippet in the page 200 OK Copy {\n \"\
          success\": true,\n \"data\": {\n \"businessId\": \"cmf8q1x4k0000\",\n \"snippet\": \"<script src=\\\"https://app.hamla.io/s/cmf8q1x4k0000.js\\\
          \" async></script>\",\n \"claimUrl\": \"htt"
  /api/sdk/identify:
    post:
      operationId: post_api_sdk_identify
      tags:
      - Api
      summary: POST /api/sdk/identify
      x-source: https://docs.hamla.io/reference/events
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiSdkIdentifyRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://app.hamla.io/api/sdk/identify  -H \"Authorization: Bearer sk_live_xxx\"  -H \"Content-Type: application/json\"\
          \  -d '{ \n \"identity\": { \"email\": \"omar@raqmi.co\" }, \n \"profile\": { \"name\": \"Omar Al Saleh\", \"country\": \"JO\" }, \n\
          \ \"method\": \"signup\" \n }' \n Resolve-or-create: an unknown person becomes a contact, a known one is enriched. Safe to call on every\
          \ login — profile fields are gap-"
  /api/sdk/track:
    post:
      operationId: post_api_sdk_track
      tags:
      - Api
      summary: POST /api/sdk/track
      x-source: https://docs.hamla.io/reference/events
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiSdkTrackRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiSdkTrackResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://app.hamla.io/api/sdk/track  -H \"Authorization: Bearer sk_live_xxx\"  -H \"Content-Type: application/json\"\
          \  -d '{ \n \"event\": \"subscription_started\", \n \"identity\": { \"email\": \"omar@raqmi.co\", \"platformCustomerId\": \"user_812\"\
          \ }, \n \"properties\": { \"plan\": \"pro\", \"seats\": 3 }, \n \"value\": 29, \n \"currency\": \"JOD\", \n \"occurredAt\": \"2026-08-23T09:41:00Z\"\
          , \n \"idempotencyKey\": \"invoice_991"
  /api/sdk/track/batch:
    post:
      operationId: post_api_sdk_track_batch
      tags:
      - Api
      summary: POST /api/sdk/track/batch
      x-source: https://docs.hamla.io/reference/events
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiSdkTrackBatchRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiSdkTrackBatchResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://app.hamla.io/api/sdk/track/batch  -H \"Authorization: Bearer sk_live_xxx\"  -H \"Content-Type: application/json\"\
          \  -d '{ \n \"events\": [ \n { \"event\": \"purchase\", \"identity\": { \"email\": \"omar@raqmi.co\" }, \n \"value\": 120, \"currency\"\
          : \"JOD\", \n \"occurredAt\": \"2025-11-02T10:00:00Z\", \"idempotencyKey\": \"order_5512\" }, \n { \"event\": \"purchase\", \"identity\"\
          : { \"email\": \"lina@example.com\" }, \n "
  /developers.md:
    get:
      operationId: get_developers_md
      tags:
      - Developers
      summary: Retrieve the developers markdown page.
      description: Returns the raw markdown content of the developers documentation.
      x-source: https://www.hamla.io/en/developers
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiInstallRequest:
      type: object
      properties:
        website:
          type: string
        name:
          type: string
        locale:
          type: string
    PostApiInstallResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            businessId:
              type: string
            snippet:
              type: string
            claimUrl:
              type: string
            expiresAt:
              type: string
              format: date-time
            note:
              type: string
        message:
          type: string
    PostApiSdkIdentifyRequest:
      type: object
      properties:
        identity:
          type: object
          properties:
            email:
              type: string
        profile:
          type: object
          properties:
            name:
              type: string
            country:
              type: string
        method:
          type: string
    PostApiSdkTrackRequest:
      type: object
      properties:
        event:
          type: string
        identity:
          type: object
          properties:
            email:
              type: string
            platformCustomerId:
              type: string
        properties:
          type: object
          properties:
            plan:
              type: string
            seats:
              type: integer
        value:
          type: integer
        currency:
          type: string
        occurredAt:
          type: string
          format: date-time
        idempotencyKey:
          type: string
        traits:
          type: object
          properties:
            plan:
              type: string
            subscription_status:
              type: string
        tags:
          type: array
          items:
            type: string
    PostApiSdkTrackResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            contactId:
              type: string
            event:
              type: string
            isNew:
              type: boolean
            deduped:
              type: boolean
            interpreted:
              type: object
              properties:
                type:
                  type: string
                countedRevenue:
                  type: integer
            warnings:
              type: array
              items:
                type: string
    PostApiSdkTrackBatchRequest:
      type: object
      properties:
        events:
          type: array
          items:
            type: object
            properties:
              event:
                type: string
              identity:
                type: object
                properties:
                  email:
                    type: string
              value:
                type: integer
              currency:
                type: string
              occurredAt:
                type: string
                format: date-time
              idempotencyKey:
                type: string
    PostApiSdkTrackBatchResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            received:
              type: integer
            recorded:
              type: integer
            deduped:
              type: integer
            failed:
              type: integer
            failures:
              type: array
              items:
                type: object
                properties:
                  index:
                    type: integer
                  error:
                    type: string
            warnings:
              type: array
              items:
                type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Developers