DOCSEARCHbyAlgolia
Submit Docs

Stubber Documentation

website·Indexed 33 days ago

https://docs.stubber.com/

Documentation for Stubber, featuring guides on Stubmation for batch automation, comprehensive PDF tools for merging, splitting, and converting documents, Handlebars helpers for data substitution, and integration guides for Microsoft Teams and Webchat canvas components.

Tokens
164.4K
Snippets
472
Records
1.4K
Agent score
53%

What's inside Stubber

  1. Overview of the Heimdall Event Bus

    Heimdall is an inter-organization event bus system used within the Stubber platform to facilitate communication between different parts of an application or between separate applications. It operates on two primary actions: registering for known events and emitting events.

  2. Overview of the Stubber Framework

    The Stubber Framework is a structured method for modeling organizational processes, procedures, and agentic AI applications. It allows developers to define how a process starts, what data is collected at each step, and the actions required to move through the process. Unlike traditional deterministic workflow tools, the framework is non-linear; states represent high-level concepts where multiple potential actions can be triggered in any order and multiple times.

  3. Overview of Stubber Email Mailboxes

    Stubber Email Mailboxes allow you to send and receive emails using custom addresses (e.g., advanced-support@org-domain.stubber.email) instead of the default Stubber Support System<{{stubref}}@stubber.email> address. Unlike Email Profiles, which require external IMAP/SMTP configuration, Email Mailboxes are created directly within Stubber's existing email service, making them easier to set up for inbound routing, reply handling, and mailbox-backed workflows.

  4. Overview of StubberDB

    StubberDB is a managed PostgreSQL instance provided to every Stubber organization. It automatically synchronizes stub data, allowing users to perform structured querying, reporting, and automation using standard SQL tooling and BI tools without building custom data pipelines.

  5. Overview of the API Call task

    The API Call task invokes external APIs from a Stubber action and returns the resulting data for use in later tasks. It is primarily used for REST integrations, data lookups, webhooks, and service-to-service automation. It supports all standard HTTP verbs (GET, POST, PUT, DELETE, PATCH) and can handle client certificate authentication and multipart/form-data uploads.

  6. Overview of Stubber Webchat advanced configuration

    Stubber Webchat provides advanced configuration options to customize the communication and behavior of the chat interface. Key capabilities include:

    • Configuring notification parameters for sending messages.
    • Implementing control channels for bidirectional communication between a webpage and a stub.
    • Customizing interface options for both embedded and hosted implementations.
    • Building interactive webchat experiences through custom payloads and client settings.

  8. Overview of the Stubber Manage application

    The Manage application in Stubber is the central administrative dashboard used to control organization operations. It provides a unified interface for managing users, permissions, billing, credentials, and communication channels. Key administrative areas include:

    • Orgs: Create and switch between multiple workspaces, each with independent teams, permissions, and billing.
    • Org UUID: Retrieve the unique identifier for the organization required for API calls and integrations.
    • Billing: Manage Stubbucks balances, configure automatic top-ups, and retrieve invoices.
    • Contacts: Handle user addition and management within the organization.
    • Teams: Group users into functional units and assign specific permissions or access to templates and integrations.
    • Usage: Analyze Stubbucks consumption metrics by date range and template.
    • Notifications: Set up communication channels including Email, Slack, WhatsApp, Facebook Messenger, Telegram, Microsoft Teams, and Webchat.
    • Credentials: Securely store API keys, tokens, and authentication details for templates and integrations.

  9. Overview of Agent Link communication

    Agent Link allows stubs to communicate as if using an external platform (like WhatsApp).

    • Initiator: The stub that starts the conversation. It addresses the agent by agent_name or stubref and must always include stubsession.set_new_with_timeout_hours to maintain the session.
    • Agent: The stub receiving the message. It does not have an address for the initiator; instead, it replies by interpolating the sessionuuid provided in the incoming message.

    Addressing methods:

    1. Agent Name: A published address (prefixed by the org domain) that works across different organizations. Requires an Agent Link profile.
    2. Stubref: A direct reference to a stub. This only works within the same organization and requires the receiving stub to opt-in via _agent_link_config in its stubdata.

  12. Overview of the manage_stubsession task

    The manage_stubsession task provides a unified interface to create, update, or remove stub sessions across different communication platforms. A stub session links a platform conversation (e.g., WhatsApp or Webchat) to a specific stub, ensuring that incoming messages are routed to the correct context. Both supported platforms utilize two core operations: set (to create/update a session) and delete (to remove a session).