Integrations SDK
The Ebbot integrations SDK allows you to create integrations for the Ebbot Platform by giving you tools to create a "Workflow server".
Workflow servers are the way the Ebbot platform can be extended by exposing actions that the Ebbot platform can take, and triggers that activate the Ebbot platform when certain events happen.
What's a Workflow Server?
A workflow server is an HTTP server that exposes a REST API that the Ebbot platform can communicate with. The SDK makes it easy to define such a server.
Get started setting up the server
Core Concepts
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 FastAPI 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.
Triggers
A trigger is something that happens in the system you integrate with. For example, a trigger could be when a new ticket is created or a user logs in.
Triggers are defined through the SDK.
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?