Kajabi · Schema

Hooks

Schema for Kajabi hooks

Creator EconomyOnline CoursesMembershipsE-CommerceDigital ProductsContactsWebhooksPayments

Properties

Name Type Description
event string
target_url string
created_at string ISO 8601 date-time, read only
updated_at string ISO 8601 date-time, read only
resource_id integernull
View JSON Schema on GitHub

JSON Schema

hooks_attributes.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/kajabi/main/json-schema/hooks_attributes.json",
  "title": "Hooks",
  "description": "Schema for Kajabi hooks",
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "enum": [
        "purchase",
        "form_submission",
        "tag_added",
        "tag_removed",
        "payment_succeeded",
        "order_created"
      ]
    },
    "target_url": {
      "type": "string"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "ISO 8601 date-time, read only"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "ISO 8601 date-time, read only"
    },
    "resource_id": {
      "type": [
        "integer",
        "null"
      ]
    }
  },
  "required": [
    "event",
    "target_url"
  ]
}