Not released yet. PeltyCMS is under development and not released yet; these docs describe the upcoming release and may change.
PeltyCMS Developer docs
User docsDevelopers
/
v0.1.0

Developer docs/Bundled addons

Hook power (test fixture)

addons.desc.integration.hooks This is a test fixture used by the integration tests; it is not offered in the marketplace.

FieldValue
Addon idintegration-hooks
Kindintegration
Provideshooks
Enginewasm
ABI0.4.0
Version0.1.0
AuthorMythicalSystems
Sourceextensions/addons/fixture-hooks
Permissions (shown at install)none

#Capabilities

CapabilityValue
filter_pointsintegration-hooks:greeting
filters[{"name":"catalog.public","priority":10},{"name":"invoice.view"},{"name":"integration-hooks:greeting"}]
hooks[{"event":"before:PUT /api/v1/client/profile","fail_open":true,"timeout_ms":150},{"event":"ticket.before_open"},{"event":"ticket.before_reply"}]
kvtrue
mixins[{"at":"around","target":"fn ticket.open","timeout_ms":500}]
routes[{"access":"client","method":"GET","path":"/state"},{"access":"client","method":"GET","path":"/greeting"}]
uioverride

#Events and hooks

WhatValue
Listens to (events)none
Hooksbefore:PUT /api/v1/client/profile, ticket.before_open, ticket.before_reply
Emitsnone
Mixinsfn ticket.open (around)
Filterscatalog.public, invoice.view, integration-hooks:greeting
Scheduled jobsnone

#Settings and secrets

No admin settings are declared in addon.json or in the source.

Secrets (stored encrypted, never returned by the API): none.

Outbound HTTP allowed to: none. $server is the hostname of the server configured for the product, $setting:<key> the host of that setting.

#HTTP routes

Mounted under /api/v1/addons/integration-hooks/.

MethodPathAccessPermission
GET/stateclient-
GET/greetingclient-

#UI

Pages: override (client). Slots: none. See Widgets and slots.

#addon.json

extensions/addons/fixture-hooks/addon.jsonJSON
{
  "abi": "0.4.0",
  "author": "MythicalSystems",
  "capabilities": {
    "filter_points": [
      "integration-hooks:greeting"
    ],
    "filters": [
      {
        "name": "catalog.public",
        "priority": 10
      },
      {
        "name": "invoice.view"
      },
      {
        "name": "integration-hooks:greeting"
      }
    ],
    "hooks": [
      {
        "event": "before:PUT /api/v1/client/profile",
        "fail_open": true,
        "timeout_ms": 150
      },
      {
        "event": "ticket.before_open"
      },
      {
        "event": "ticket.before_reply"
      }
    ],
    "kv": true,
    "mixins": [
      {
        "at": "around",
        "target": "fn ticket.open",
        "timeout_ms": 500
      }
    ],
    "routes": [
      {
        "access": "client",
        "method": "GET",
        "path": "/state"
      },
      {
        "access": "client",
        "method": "GET",
        "path": "/greeting"
      }
    ],
    "ui": [
      "override"
    ]
  },
  "description": "addons.desc.integration.hooks",
  "engine": "wasm",
  "id": "integration-hooks",
  "kind": "integration",
  "name": "Hook power (test fixture)",
  "permissions": [],
  "provides": "hooks",
  "settings": [],
  "ui": {
    "overrides": {
      "hide_nav": [
        "/hooks-fixture-hidden"
      ],
      "pages": {
        "client.hooks-fixture": "override"
      }
    },
    "pages": [
      {
        "area": "client",
        "body": {
          "text": "overridden by fixture",
          "type": "text"
        },
        "id": "override",
        "nav": false,
        "title": "plugin.integration-hooks.override_title"
      }
    ]
  },
  "version": "0.1.0",
  "wasm": "addon.wasm"
}