RidgeCRM Developer Docs

API Reference

Platform automation API

Manage custom object definitions, trigger definitions, and automation-adjacent platform metadata.

Custom object deploy flow

1

Create definition

Create the custom object shell with labels and API name.

2

Add fields

Attach text, number, lookup, picklist, formula, or date fields.

3

Deploy

Provision storage and mark the object usable.

4

Create records

Use the records endpoint and then expose the object in pages.

Endpoints

POST /api/v1/platform/custom-objects Bearer JWT + org

Create a tenant-owned custom object definition.

Request

POST /api/v1/platform/custom-objects
Authorization: Bearer <jwt>
X-Organization-ID: <organization-id>
Content-Type: application/json

{
  "label": "Subscription",
  "pluralLabel": "Subscriptions",
  "apiName": "subscription"
}

Response

{
  "definition": {
    "id": "obj_123",
    "apiName": "subscription",
    "label": "Subscription",
    "isDeployed": false
  }
}
POST /api/v1/platform/triggers Bearer JWT + org

Register or update platform trigger metadata for a JavaScript handler or webhook.

Request

POST /api/v1/platform/triggers
Authorization: Bearer <jwt>
X-Organization-ID: <organization-id>
Content-Type: application/json

{
  "name": "Enrich new leads",
  "objectTypeKey": "Lead",
  "triggerEvent": "AFTER_CREATE",
  "handlerType": "CODE_KEY",
  "handlerKey": "lead.enrich.afterCreate",
  "isActive": true
}

Response

{
  "trigger": {
    "id": "trigger_123",
    "handlerKey": "lead.enrich.afterCreate",
    "isActive": true
  }
}