Modules
Kapso Agent modes:
built-in and custom modes with their instructions, tools and
permissions. Only modes whose available_invocations include "api"
accept runs from KapsoEx.Agent.Runs.create/2.
Trigger and control Kapso Agent runs.
Kapso Agent sessions: conversations made of runs. Only sessions created with the API key in use are visible.
Holds the credentials and HTTP settings used for every request.
Returned as {:error, %KapsoEx.Error{}} when a request fails.
Functions: serverless JavaScript deployed by Kapso, invoked over the API or from workflows.
Lazily walks every page of a list endpoint.
The Platform API (https://api.kapso.ai/platform/v1): everything around
the messages, such as onboarding customers, connecting numbers, setup
links, broadcasts, webhooks and project data.
Logs of the API calls made with your project's keys.
Send an approved template to many recipients, with per-recipient tracking. See the Broadcasts API guide.
Submit a customer's business documents to Meta for business verification.
WhatsApp contacts of the project.
Query conversations across the project, close or reopen them, and assign them to team members.
Customers are the businesses you onboard to WhatsApp. See Onboard customers.
Display name change requests. Meta reviews most changes within 24-48
hours; poll get/3 to follow the review.
Project events: timestamped
data points you record (for example order.created) that can trigger
workflows, plus the definitions that describe them.
Findings: recurring problems Kapso detects in your conversations, with AI investigations.
WhatsApp Flows managed by Kapso: versions, publishing, encryption and data endpoints (serverless functions that serve dynamic flow data).
WhatsApp funding and usage for Tech Providers with managed billing: funding status per WhatsApp Business Account (WABA) and portfolio, recorded charges, and stopping funding.
Access links to embed the Kapso inbox in your own application through an iframe.
Search the same log events shown in the Kapso logs UI: API logs, WhatsApp webhook events, flow events and webhook deliveries.
Ingest media from a public URL so it can be sent in messages.
Query WhatsApp messages across all conversations and numbers of the
project. To send messages use KapsoEx.WhatsApp.Messages.
Route Kapso notification events to team destinations (shared email addresses or Slack channels).
WhatsApp numbers connected to your Kapso project.
AI provider models available to agent nodes and Kapso Agent modes.
Setup links are hosted onboarding pages where a customer connects their WhatsApp number. See Create and configure.
Members of your Kapso project, for example to assign conversations.
Delivery attempts of your webhooks, useful to debug failures.
Webhook subscriptions.
Verifies and decodes webhooks sent by Kapso.
A Plug.Parsers body reader that keeps the raw request body, which is
needed to verify webhook signatures after the JSON has been parsed.
Helpers shared by the WhatsApp API modules.
Block users from messaging a phone number, and unblock them.
The business profile users see when they tap your business name in WhatsApp.
WhatsApp Calling: call logs, call actions and call permissions.
Contacts stored by Kapso for a phone number.
Conversations stored by Kapso for a phone number, plus thread control on shared numbers.
Meta Conversions API for WhatsApp: datasets and conversion events.
WhatsApp Flows through Meta's Graph API shapes (proxied by Kapso).
Upload, inspect, delete and download WhatsApp media.
Send WhatsApp messages and read stored message history.
Phone number details and settings, as returned by Meta.
Builders for the components list sent with a template message.
Manage message templates of a WhatsApp Business Account (WABA).
Business usernames for a phone number.
Workflows: automated WhatsApp conversations built from nodes and edges.
Start and resume workflow executions and read their history.
Triggers start a workflow automatically: on an inbound message, a WhatsApp event, a project event, or an API call.