Skip to content

About

SDK for building Escalated plugins — framework-agnostic, TypeScript-first

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Escalated

Escalated Plugin SDK

Write Escalated plugins once in TypeScript.
The same plugin runs on every Escalated backend through the plugin runtime.

Website · Docs · Cloud · Releases


import { definePlugin } from '@escalated-dev/plugin-sdk'

export default definePlugin({
  name: 'my-plugin',
  version: '1.0.0',

  actions: {
    'ticket.created': async (event, ctx) => {
      ctx.log.info('New ticket!', event)
    },
  },
})

What it does

Hook into the helpdesk

React to ticket events, change values as they pass through filters, and add your own endpoints, webhooks and scheduled tasks.

Extend the UI without forking it

Add admin pages with menu items, put panels into existing pages, and show dashboard widgets with live badges.

Features

Hooks

  • Action hooks, fire-and-forget
  • Filter hooks with priorities
  • Emit custom hooks for other plugins

HTTP

  • REST endpoints with capability checks
  • Incoming webhooks
  • Raw request bytes for signature checks
  • Real HTTP statuses with httpResponse

Schedule and lifecycle

  • Cron tasks keyed by expression
  • Activate and deactivate hooks
  • Settings fields in the admin UI

Helpdesk data

  • Tickets, replies and contacts
  • Tags, departments and agents
  • The current user

Plugin services

  • Plugin-scoped key-value and query store
  • Config values, outbound HTTP, logging
  • Broadcast to channels, users or tickets

UI and real-time

  • Full-page routes with menu items
  • Components injected into page slots
  • Dashboard widgets with badges
  • React to broadcast ticket events

Every feature in detail

TypeScript 5.4+ Node.js JSON-RPC 2.0

Quick start

npm install @escalated-dev/plugin-sdk

Define your plugin with definePlugin as above. The getting started guide lists the requirements.

Learn more

License

MIT. Copyright (c) Escalated.dev. See LICENSE.

About

SDK for building Escalated plugins — framework-agnostic, TypeScript-first

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages