Skip to main content
Kapso logo
  • Category: communication
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: KAPSO
  • Version: 20261101_00

Tools

Slug: KAPSO_GET_CONTACTRetrieve one Kapso WhatsApp contact by UUID, phone number, business-scoped user ID, or parent business-scoped user ID. A parent business-scoped user ID can match multiple contacts; Kapso returns the most recently created one.

Input Parameters

string
required
Contact UUID, WhatsApp phone number, business-scoped user ID, or parent business-scoped user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KAPSO_GET_FUNCTIONRetrieve one Kapso serverless function’s code, runtime configuration, deployment status, and computed URLs without invoking or changing it.

Input Parameters

string
required
Function UUID returned by KAPSO_LIST_FUNCTIONS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KAPSO_GET_PHONE_NUMBERRetrieve one Kapso WhatsApp phone-number configuration by its Meta phone number ID.

Input Parameters

string
required
Meta phone number ID returned by KAPSO_LIST_PHONE_NUMBERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KAPSO_GET_PHONE_NUMBER_HEALTHRun Kapso’s live checks for one WhatsApp phone-number configuration and return its body-level health status and individual check results.

Input Parameters

string
required
Meta phone number ID returned by KAPSO_LIST_PHONE_NUMBERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KAPSO_GET_WORKFLOWRetrieve one workflow’s metadata, full graph definition, or available variables without executing or changing it.

Input Parameters

string ("metadata" | "definition" | "variables")
Choose metadata and execution stats, the complete nodes and edges graph, or fixed and discovered variables.
string
required
Workflow UUID returned by KAPSO_LIST_WORKFLOWS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KAPSO_LIST_CONVERSATIONSList one page of WhatsApp conversations by recent activity, with filters for phone number, status, assignment, and activity time range.

Input Parameters

integer
Maximum conversations to return on this page (1-100).
string ("active" | "ended")
Filter by active or ended conversation status.
boolean
Set true to return only unassigned conversations; cannot be combined with assigned_user_id.
string
Continuation cursor returned by a previous call; omit for the first page and pass it back unchanged.
string
Filter by Meta phone number ID.
string
Filter by active assignee project-user UUID.
string
Return conversations active after this ISO 8601 timestamp.
string
Return conversations active before this ISO 8601 timestamp.
string
Filter by a partial contact phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KAPSO_LIST_CUSTOMERSList Kapso project customers and filter them by name, external customer ID, or creation time. Returns one page and a continuation cursor.

Input Parameters

integer
Maximum customers to return on this page (minimum 1).
string
Continuation cursor returned by a previous call; omit for the first page.
string
Return customers created at or after this ISO 8601 timestamp.
string
Filter by a customer-name substring.
string
Return customers created at or before this ISO 8601 timestamp.
string
Filter by the caller-defined external customer ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KAPSO_LIST_FUNCTIONSList serverless functions configured in the Kapso project, including runtime and deployment state, without returning function source code or invoking any function.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KAPSO_LIST_MESSAGESList one page of WhatsApp message history project-wide through Kapso Platform or for one phone number through the Meta-compatible proxy. This tool only reads history and never sends messages.

Input Parameters

integer
Maximum messages to return on this page (1-100).
string ("pending" | "sent" | "delivered" | "read" | "failed")
Filter by message delivery status.
string ("inbound" | "outbound")
Filter by inbound or outbound direction.
string ("platform" | "meta_proxy")
Use platform for project-wide history or meta_proxy for one phone number’s Meta-compatible history.
string
Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged; its original surface and filters are restored automatically.
string
Filter messages by conversation ID.
string
Filter Platform results by Meta phone number ID. Required for api_surface=‘meta_proxy’, where it identifies the path resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KAPSO_LIST_PHONE_NUMBERSList WhatsApp phone-number configurations in the Kapso project, with filters for account, customer, messaging state, and display name.

Input Parameters

integer
Maximum phone-number configurations to return on this page (minimum 1).
string
Filter by Kapso customer UUID.
string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter by a case-insensitive display-name substring.
string
Return only the configuration with this Meta phone number ID.
boolean
Filter by whether messaging is enabled.
string
Filter by WhatsApp Business Account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KAPSO_LIST_WORKFLOWSList project workflows and filter them by lifecycle status, name, or creation time. This read-only action does not execute a workflow.

Input Parameters

string ("draft" | "active" | "archived")
Filter by workflow lifecycle status.
string
Return workflows created at or after this ISO 8601 timestamp.
string
Filter by a case-insensitive workflow-name substring.
string
Return workflows created at or before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KAPSO_UPDATE_CONTACTUpdate a Kapso WhatsApp contact’s phone-number identity, profile, customer association, or metadata. A parent business-scoped user ID can match multiple contacts; Kapso updates the most recently created one.

Input Parameters

string
Replacement WhatsApp phone-number identity in E.164 format.
object
Replacement custom key-value metadata. Supply an empty object to clear it.
string
required
Contact UUID, WhatsApp phone number, business-scoped user ID, or parent business-scoped user ID.
string
Replacement Kapso customer UUID to associate with the contact.
string
Replacement application-defined display name.
string
Replacement name shown on the contact’s WhatsApp profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not