SDK Core Concepts

This page walks you through the core concepts of the Ebbot Integrations SDK.

Core concepts of Integrations SDK

A workflow server consists of the following concepts:

The server

The server exposes a REST API that the ebbot platform can interpret. This SDK uses FastAPIarrow-up-right to spin up that server.

Connections

Integrating with external systems requires settings and credentials to access that system, and the credentials are different for each client. A connection represents a set of credentials that can be used to connect to the system you integrate with.

A server usually has many connections, one for each client that's using it.

Subscriptions

A trigger can be subscribed to by a service, for example the Ebbot Automations platform. The SDK takes care of notifying all subscribers when a trigger is invoked.

Actions

An action is something that can be performed by the workflow server. For example, it could be creating a ticket, updating an existing ticket or adding a reply.

The Manifest

The manifest describes all available connections, triggers and actions. The manifest is automatically generated by the SDK, and it's used by the Ebbot platform to discover what capabilities a workflow server can have.

Last updated

Was this helpful?