.svg){kind=logo}
Introduction
Core concepts
- Organizations
- Teams
- Tickets
- Custom fields
- Work units
- Accounts
- Workflows
Apps framework
Sources
- Slack
- Email
Workflows
Activities
Complete guide to workflow activities in the Thena platform
Activities are the building blocks of workflows in the Thena platform. They represent the actual operations to be performed when a workflow executes, enabling automation of various business processes.
Understanding activities
Core purpose
Activities provide a structured way to define and execute operations within workflows. Each activity represents a discrete, reusable operation that can be configured, secured, and monitored.
Activity types
System activities
• Data manipulation: Transform, filter, format
• Flow control: Branch, delay
App activities
• Ticket activities: Create, update, assign
• User activities: Create, update, permissions
• Integration activities: API calls, webhooks
Activity anatomy
Core properties
Identifiers
• uid: Unique system identifier
• name: Human-readable name
• uniqueIdentifier: Machine-readable identifier (e.g., tickets:create-ticket-platform)
• version: Activity version number
• source: Origin application
Metadata
• description: Purpose description
• throttler: Rate limiting configuration
• metadata: Additional configuration data
Schema structure
Input parameters definition:
- Required fields
- Optional fields
- Data types and validation
- Nested object structures
Output data definition:
- Required response fields
- Optional response fields
- Success/failure indicators
- Return data structure
Rate limiting configuration:
- Time window (TTL)
- Request limits
- Key definition
- Enable/disable flag
Core platform activities
Ticket management
Scope: Organization
Source: Platform
Description: Creates a new ticket
Request payload:
Copy
Ask AI
{
"title": {
"type": "string",
"required": true,
"description": "Title of the ticket"
},
"requestorEmail": {
"type": "string",
"required": true,
"description": "Email of the person requesting the ticket"
},
"teamId": {
"type": "string",
"required": true,
"description": "ID of the team to assign the ticket to"
},
"description": {
"type": "string",
"optional": true,
"description": "Detailed description of the ticket"
},
"accountId": {
"type": "string",
"optional": true,
"description": "ID of the associated account"
},
"typeId": {
"type": "string",
"optional": true,
"description": "Type of the ticket"
},
"statusId": {
"type": "string",
"optional": true,
"description": "Status of the ticket"
},
"priorityId": {
"type": "string",
"optional": true,
"description": "Priority of the ticket"
},
"assignedAgentId": {
"type": "string",
"optional": true,
"description": "ID of the agent to assign the ticket to"
},
"isPrivate": {
"type": "boolean",
"optional": true,
"description": "Whether the ticket is private"
},
"dueDate": {
"type": "string",
"optional": true,
"description": "Due date for the ticket"
},
"source": {
"type": "string",
"optional": true,
"description": "Source of the ticket"
},
"attachmentUrls": {
"type": "array",
"items": {
"type": "string"
},
"optional": true,
"description": "URLs of attached files"
},
"customFieldValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"customFieldId": {
"type": "string",
"required": true
},
"data": {
"type": "object",
"required": true
}
}
},
"optional": true,
"description": "Custom field values"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "Unique identifier of the created ticket"
},
"title": {
"type": "string",
"required": true,
"description": "Title of the ticket"
},
"ticketId": {
"type": "number",
"required": true,
"description": "Numeric ID of the ticket"
},
"teamId": {
"type": "string",
"required": true,
"description": "Team ID"
},
"teamName": {
"type": "string",
"required": true,
"description": "Team name"
},
"requestorEmail": {
"type": "string",
"required": true,
"description": "Email of the requestor"
},
"status": {
"type": "string",
"optional": true,
"description": "Current status"
},
"priority": {
"type": "string",
"optional": true,
"description": "Current priority"
},
"description": {
"type": "string",
"optional": true,
"description": "Ticket description"
},
"assignedAgent": {
"type": "string",
"optional": true,
"description": "Name of assigned agent"
},
"assignedAgentId": {
"type": "string",
"optional": true,
"description": "ID of assigned agent"
},
"assignedAgentEmail": {
"type": "string",
"optional": true,
"description": "Assigned agent email"
},
"accountId": {
"type": "string",
"optional": true,
"description": "Associated account ID"
},
"isPrivate": {
"type": "boolean",
"required": true,
"description": "Whether the ticket is private"
},
"createdAt": {
"type": "string",
"required": true,
"description": "Ticket creation timestamp"
},
"updatedAt": {
"type": "string",
"required": true,
"description": "Last update timestamp"
}
}
Scope: Organization
Source: Platform
Description: Updates an existing ticket
Request payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "ID of the ticket to update"
},
"title": {
"type": "string",
"optional": true,
"description": "New title for the ticket"
},
"description": {
"type": "string",
"optional": true,
"description": "New description for the ticket"
},
"teamId": {
"type": "string",
"optional": true,
"description": "New team ID"
},
"typeId": {
"type": "string",
"optional": true,
"description": "New type ID"
},
"statusId": {
"type": "string",
"optional": true,
"description": "New status ID"
},
"priorityId": {
"type": "string",
"optional": true,
"description": "New priority ID"
},
"accountId": {
"type": "string",
"optional": true,
"description": "New account ID"
},
"assignedAgentId": {
"type": "string",
"optional": true,
"description": "New assigned agent ID"
},
"isPrivate": {
"type": "boolean",
"optional": true,
"description": "Whether the ticket is private"
},
"dueDate": {
"type": "string",
"optional": true,
"description": "New due date"
},
"attachmentUrls": {
"type": "array",
"optional": true,
"items": {
"type": "string"
},
"description": "List of attachment URLs"
},
"customFieldValues": {
"type": "array",
"optional": true,
"items": {
"type": "object",
"properties": {
"customFieldId": {
"type": "string",
"required": true
},
"data": {
"type": "object",
"required": true
}
}
},
"description": "Custom field values"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true
},
"title": {
"type": "string",
"required": true
},
"ticketId": {
"type": "number",
"required": true
},
"teamId": {
"type": "string",
"required": true
},
"teamName": {
"type": "string",
"required": true
},
"requestorEmail": {
"type": "string",
"required": true
},
"status": {
"type": "string",
"optional": true
},
"type": {
"type": "string",
"optional": true
},
"priority": {
"type": "string",
"optional": true
},
"description": {
"type": "string",
"optional": true
},
"assignedAgent": {
"type": "string",
"optional": true
},
"assignedAgentId": {
"type": "string",
"optional": true
},
"assignedAgentEmail": {
"type": "string",
"optional": true,
"description": "Assigned agent email"
},
"accountId": {
"type": "string",
"optional": true
},
"isPrivate": {
"type": "boolean",
"required": true
},
"createdAt": {
"type": "string",
"required": true
},
"updatedAt": {
"type": "string",
"required": true
}
}
Scope: Team
Source: Platform
Compensation: Compensate assign ticket
Description: Assigns a ticket to an agent
Request payload:
Copy
Ask AI
{
"ticketId": {
"type": "string",
"required": true,
"description": "ID of the ticket to assign"
},
"agentId": {
"type": "string",
"required": true,
"description": "ID of the agent to assign the ticket to"
},
"unassign": {
"type": "boolean",
"optional": true,
"description": "Whether to unassign the ticket instead"
}
}
Response payload:
Copy
Ask AI
{
"success": {
"type": "boolean",
"required": true,
"description": "Whether the assignment was successful"
},
"ticket": {
"type": "object",
"required": true,
"description": "The updated ticket object",
"properties": {
"id": {
"type": "string",
"required": true,
"description": "Ticket ID"
},
"title": {
"type": "string",
"required": true,
"description": "Ticket title"
},
"ticketId": {
"type": "number",
"required": true,
"description": "Numeric ticket identifier"
},
"teamId": {
"type": "string",
"required": true,
"description": "Team ID"
},
"teamName": {
"type": "string",
"required": true,
"description": "Team name"
},
"requestorEmail": {
"type": "string",
"required": true,
"description": "Email of the ticket requestor"
},
"assignedAgent": {
"type": "string",
"optional": true,
"description": "Name of the assigned agent"
},
"assignedAgentId": {
"type": "string",
"optional": true,
"description": "ID of the assigned agent"
},
"assignedAgentEmail": {
"type": "string",
"optional": true,
"description": "Email of the assigned agent"
},
"status": {
"type": "string",
"optional": true,
"description": "Ticket status"
},
"priority": {
"type": "string",
"optional": true,
"description": "Ticket priority"
},
"description": {
"type": "string",
"optional": true,
"description": "Ticket description"
},
"accountId": {
"type": "string",
"optional": true,
"description": "Associated account ID"
},
"isPrivate": {
"type": "boolean",
"required": true,
"description": "Whether the ticket is private"
},
"createdAt": {
"type": "string",
"required": true,
"description": "Ticket creation timestamp"
},
"updatedAt": {
"type": "string",
"required": true,
"description": "Last update timestamp"
}
}
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Escalates a ticket
Request payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "ID of the ticket to escalate"
},
"reason": {
"type": "string",
"required": true,
"description": "Reason for escalation"
},
"details": {
"type": "string",
"required": true,
"description": "Detailed explanation of the escalation"
},
"impact": {
"type": "string",
"required": true,
"description": "Impact level of the escalation"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "Ticket ID"
},
"title": {
"type": "string",
"required": true,
"description": "Ticket title"
},
"ticketId": {
"type": "number",
"required": true,
"description": "Numeric ticket identifier"
},
"teamId": {
"type": "string",
"required": true,
"description": "Team ID"
},
"teamName": {
"type": "string",
"required": true,
"description": "Team name"
},
"requestorEmail": {
"type": "string",
"required": true,
"description": "Email of the ticket requestor"
},
"description": {
"type": "string",
"optional": true,
"description": "Ticket description"
},
"status": {
"type": "string",
"optional": true,
"description": "Ticket status"
},
"priority": {
"type": "string",
"optional": true,
"description": "Ticket priority"
},
"assignedAgent": {
"type": "string",
"optional": true,
"description": "Name of the assigned agent"
},
"assignedAgentId": {
"type": "string",
"optional": true,
"description": "ID of the assigned agent"
},
"assignedAgentEmail": {
"type": "string",
"optional": true,
"description": "Email of the assigned agent"
},
"accountId": {
"type": "string",
"optional": true,
"description": "Associated account ID"
},
"isPrivate": {
"type": "boolean",
"required": true,
"description": "Whether the ticket is private"
},
"createdAt": {
"type": "string",
"required": true,
"description": "Ticket creation timestamp"
},
"updatedAt": {
"type": "string",
"required": true,
"description": "Last update timestamp"
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Archives a ticket
Request payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "ID of the ticket to archive"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "Ticket ID"
},
"title": {
"type": "string",
"required": true,
"description": "Ticket title"
},
"ticketId": {
"type": "number",
"required": true,
"description": "Numeric ticket identifier"
},
"teamId": {
"type": "string",
"required": true,
"description": "Team ID"
},
"teamName": {
"type": "string",
"required": true,
"description": "Team name"
},
"requestorEmail": {
"type": "string",
"required": true,
"description": "Email of the ticket requestor"
},
"description": {
"type": "string",
"optional": true,
"description": "Ticket description"
},
"status": {
"type": "string",
"optional": true,
"description": "Ticket status"
},
"priority": {
"type": "string",
"optional": true,
"description": "Ticket priority"
},
"assignedAgent": {
"type": "string",
"optional": true,
"description": "Name of the assigned agent"
},
"assignedAgentId": {
"type": "string",
"optional": true,
"description": "ID of the assigned agent"
},
"assignedAgentEmail": {
"type": "string",
"optional": true,
"description": "Email of the assigned agent"
},
"accountId": {
"type": "string",
"optional": true,
"description": "Associated account ID"
},
"isPrivate": {
"type": "boolean",
"required": true,
"description": "Whether the ticket is private"
},
"archivedAt": {
"type": "string",
"optional": true,
"description": "Timestamp when the ticket was archived"
},
"createdAt": {
"type": "string",
"required": true,
"description": "Ticket creation timestamp"
},
"updatedAt": {
"type": "string",
"required": true,
"description": "Last update timestamp"
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Gets a ticket by ID
Request payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "ID of the ticket to retrieve"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "Ticket ID"
},
"title": {
"type": "string",
"required": true,
"description": "Ticket title"
},
"ticketId": {
"type": "number",
"required": true,
"description": "Numeric ticket identifier"
},
"teamId": {
"type": "string",
"required": true,
"description": "Team ID"
},
"teamName": {
"type": "string",
"required": true,
"description": "Team name"
},
"requestorEmail": {
"type": "string",
"required": true,
"description": "Email of the ticket requestor"
},
"description": {
"type": "string",
"optional": true,
"description": "Ticket description"
},
"status": {
"type": "string",
"optional": true,
"description": "Ticket status"
},
"priority": {
"type": "string",
"optional": true,
"description": "Ticket priority"
},
"assignedAgent": {
"type": "string",
"optional": true,
"description": "Assigned agent name"
},
"assignedAgentId": {
"type": "string",
"optional": true,
"description": "Assigned agent ID"
},
"assignedAgentEmail": {
"type": "string",
"optional": true,
"description": "Assigned agent email"
},
"accountId": {
"type": "string",
"optional": true,
"description": "Associated account ID"
},
"isPrivate": {
"type": "boolean",
"required": true,
"description": "Whether the ticket is private"
},
"createdAt": {
"type": "string",
"required": true,
"description": "Ticket creation timestamp"
},
"updatedAt": {
"type": "string",
"required": true,
"description": "Last update timestamp"
}
}
Comment management
Scope: Organization
Source: Platform
Description: Creates a comment on an entity
Request payload:
Copy
Ask AI
{
"content": {
"type": "string",
"required": true,
"description": "Content of the comment"
},
"entityType": {
"type": "string",
"required": true,
"description": "Type of entity the comment is for (e.g., 'ticket')"
},
"entityId": {
"type": "string",
"required": true,
"description": "ID of the entity the comment is for"
},
"metadata": {
"type": "string",
"required": false,
"description": "Additional metadata for the comment"
},
"threadName": {
"type": "string",
"required": false,
"description": "Name of the thread this comment belongs to"
},
"commentType": {
"type": "string",
"required": false,
"description": "Type of comment"
},
"attachmentUrls": {
"type": "array",
"required": false,
"description": "Array of attachment URLs",
"items": {
"type": "string"
}
},
"parentCommentId": {
"type": "string",
"required": false,
"description": "ID of parent comment if this is a reply"
},
"commentVisibility": {
"type": "string",
"required": false,
"description": "Visibility setting for the comment"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "Comment ID"
},
"content": {
"type": "string",
"required": true,
"description": "Comment content"
},
"contentHtml": {
"type": "string",
"required": true,
"description": "Comment content in HTML format"
},
"contentMarkdown": {
"type": "string",
"required": true,
"description": "Comment content in Markdown format"
},
"author": {
"type": "string",
"required": true,
"description": "Author name"
},
"authorId": {
"type": "string",
"required": true,
"description": "Author ID"
},
"authorUserType": {
"type": "string",
"required": true,
"description": "Type of user who authored the comment"
},
"isEdited": {
"type": "boolean",
"required": true,
"description": "Whether the comment has been edited"
},
"isPinned": {
"type": "boolean",
"required": true,
"description": "Whether the comment is pinned"
},
"threadName": {
"type": "string",
"required": true,
"description": "Thread name"
},
"commentVisibility": {
"type": "string",
"required": true,
"description": "Comment visibility setting"
},
"commentType": {
"type": "string",
"required": true,
"description": "Type of comment"
},
"parentCommentId": {
"type": "string",
"required": false,
"description": "Parent comment ID if this is a reply"
},
"sourceEmailId": {
"type": "string",
"required": false,
"description": "Source email ID if comment came from email"
},
"metadata": {
"type": "object",
"required": true,
"description": "Comment metadata including reactions, replies, mentions"
},
"attachments": {
"type": "array",
"required": false,
"description": "Array of attachment objects"
},
"createdAt": {
"type": "string",
"required": true,
"description": "Creation timestamp"
},
"updatedAt": {
"type": "string",
"required": true,
"description": "Last update timestamp"
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Updates an existing comment
Request payload:
Copy
Ask AI
{
"commentId": {
"type": "string",
"required": true,
"description": "ID of the comment to update"
},
"content": {
"type": "string",
"required": false,
"description": "New content for the comment"
},
"threadName": {
"type": "string",
"required": false,
"description": "New thread name"
},
"attachments": {
"type": "array",
"required": false,
"description": "Array of attachment URLs",
"items": {
"type": "string"
}
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "Comment ID"
},
"content": {
"type": "string",
"required": true,
"description": "Updated comment content"
},
"contentHtml": {
"type": "string",
"required": true,
"description": "Comment content in HTML format"
},
"contentMarkdown": {
"type": "string",
"required": true,
"description": "Comment content in Markdown format"
},
"author": {
"type": "string",
"required": true,
"description": "Author name"
},
"authorId": {
"type": "string",
"required": true,
"description": "Author ID"
},
"authorUserType": {
"type": "string",
"required": true,
"description": "Type of user who authored the comment"
},
"isEdited": {
"type": "boolean",
"required": true,
"description": "Whether the comment has been edited (will be true after update)"
},
"isPinned": {
"type": "boolean",
"required": true,
"description": "Whether the comment is pinned"
},
"threadName": {
"type": "string",
"required": true,
"description": "Thread name"
},
"commentVisibility": {
"type": "string",
"required": true,
"description": "Comment visibility setting"
},
"commentType": {
"type": "string",
"required": true,
"description": "Type of comment"
},
"parentCommentId": {
"type": "string",
"required": false,
"description": "Parent comment ID if this is a reply"
},
"sourceEmailId": {
"type": "string",
"required": false,
"description": "Source email ID if comment came from email"
},
"metadata": {
"type": "object",
"required": true,
"description": "Comment metadata including reactions, replies, mentions"
},
"attachments": {
"type": "array",
"required": false,
"description": "Array of attachment objects"
},
"createdAt": {
"type": "string",
"required": true,
"description": "Creation timestamp"
},
"updatedAt": {
"type": "string",
"required": true,
"description": "Last update timestamp"
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Deletes a comment
Request payload:
Copy
Ask AI
{
"commentId": {
"type": "string",
"required": true,
"description": "ID of the comment to delete"
}
}
Response payload:
Copy
Ask AI
{
"success": {
"type": "boolean",
"description": "Indicates if the deletion was successful"
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Retrieves a single comment by ID
Request payload:
Copy
Ask AI
{
"commentId": {
"type": "string",
"required": true,
"description": "ID of the comment to retrieve"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "Comment ID"
},
"content": {
"type": "string",
"required": true,
"description": "Comment content"
},
"contentHtml": {
"type": "string",
"required": true,
"description": "Comment content in HTML format"
},
"contentMarkdown": {
"type": "string",
"required": true,
"description": "Comment content in Markdown format"
},
"author": {
"type": "string",
"required": true,
"description": "Author name"
},
"authorId": {
"type": "string",
"required": true,
"description": "Author ID"
},
"authorUserType": {
"type": "string",
"required": true,
"description": "Type of user who authored the comment"
},
"isEdited": {
"type": "boolean",
"required": true,
"description": "Whether the comment has been edited"
},
"isPinned": {
"type": "boolean",
"required": true,
"description": "Whether the comment is pinned"
},
"threadName": {
"type": "string",
"required": true,
"description": "Thread name"
},
"commentVisibility": {
"type": "string",
"required": true,
"description": "Comment visibility setting"
},
"commentType": {
"type": "string",
"required": true,
"description": "Type of comment"
},
"parentCommentId": {
"type": "string",
"required": false,
"description": "Parent comment ID if this is a reply"
},
"sourceEmailId": {
"type": "string",
"required": false,
"description": "Source email ID if comment came from email"
},
"metadata": {
"type": "object",
"required": true,
"description": "Comment metadata including reactions, replies, mentions"
},
"attachments": {
"type": "array",
"required": false,
"description": "Array of attachment objects"
},
"createdAt": {
"type": "string",
"required": true,
"description": "Creation timestamp"
},
"updatedAt": {
"type": "string",
"required": true,
"description": "Last update timestamp"
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Retrieves comments for an entity with pagination
Request payload:
Copy
Ask AI
{
"entityType": {
"type": "string",
"required": true,
"description": "Type of entity to get comments for (e.g., 'ticket')"
},
"entityId": {
"type": "string",
"required": true,
"description": "ID of the entity to get comments for"
},
"page": {
"type": "number",
"required": false,
"description": "Page number for pagination"
},
"limit": {
"type": "number",
"required": false,
"description": "Number of comments per page"
}
}
Response payload:
Copy
Ask AI
{
"comments": {
"type": "array",
"required": true,
"description": "Array of comment objects",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Comment ID"
},
"content": {
"type": "string",
"description": "Comment content"
},
"contentHtml": {
"type": "string",
"description": "Comment content in HTML format"
},
"contentMarkdown": {
"type": "string",
"description": "Comment content in Markdown format"
},
"author": {
"type": "string",
"description": "Author name"
},
"authorId": {
"type": "string",
"description": "Author ID"
},
"authorUserType": {
"type": "string",
"description": "Type of user who authored the comment"
},
"isEdited": {
"type": "boolean",
"description": "Whether the comment has been edited"
},
"isPinned": {
"type": "boolean",
"description": "Whether the comment is pinned"
},
"threadName": {
"type": "string",
"description": "Thread name"
},
"commentVisibility": {
"type": "string",
"description": "Comment visibility setting"
},
"commentType": {
"type": "string",
"description": "Type of comment"
},
"parentCommentId": {
"type": "string",
"description": "Parent comment ID if this is a reply"
},
"sourceEmailId": {
"type": "string",
"description": "Source email ID if comment came from email"
},
"metadata": {
"type": "object",
"description": "Comment metadata including reactions, replies, mentions"
},
"attachments": {
"type": "array",
"description": "Array of attachment objects"
},
"createdAt": {
"type": "string",
"description": "Creation timestamp"
},
"updatedAt": {
"type": "string",
"description": "Last update timestamp"
}
}
}
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Adds a reaction to a comment
Request payload:
Copy
Ask AI
{
"commentId": {
"type": "string",
"required": true,
"description": "ID of the comment to add reaction to"
},
"reactionName": {
"type": "string",
"required": true,
"description": "Name of the reaction/emoji to add"
}
}
Response payload:
Copy
Ask AI
{
"success": {
"type": "boolean",
"required": true,
"description": "Whether the reaction was successfully added"
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Removes a reaction from a comment
Request payload:
Copy
Ask AI
{
"commentId": {
"type": "string",
"required": true,
"description": "ID of the comment to remove reaction from"
},
"reactionName": {
"type": "string",
"required": true,
"description": "Name of the reaction/emoji to remove"
}
}
Response payload:
Copy
Ask AI
{
"success": {
"type": "boolean",
"required": true,
"description": "Whether the reaction was successfully removed"
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Retrieves available emojis for reactions
Request payload:
Copy
Ask AI
{}
Response payload:
Copy
Ask AI
{
"emojis": {
"type": "array",
"required": true,
"description": "List of available emojis",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"required": true,
"description": "Display name of the emoji"
},
"unicode": {
"type": "string",
"required": true,
"description": "Unicode representation of the emoji"
},
"shortcode": {
"type": "string",
"required": true,
"description": "Shortcode for the emoji (e.g., :smile:)"
},
"category": {
"type": "string",
"required": true,
"description": "Category the emoji belongs to"
},
"keywords": {
"type": "array",
"required": true,
"description": "Keywords associated with the emoji",
"items": {
"type": "string"
}
}
}
}
}
}
Connection details: Platform API
Account management
Scope: Organization
Source: Platform
Description: Creates a new account
Request payload:
Copy
Ask AI
{
"name": {
"type": "string",
"required": true,
"description": "Account name"
},
"primaryDomain": {
"type": "string",
"required": true,
"description": "Primary domain for the account"
},
"logo": {
"type": "string",
"optional": true
},
"website": {
"type": "string",
"optional": true
},
"description": {
"type": "string",
"optional": true
},
"industry": {
"type": "string",
"optional": true
},
"status": {
"type": "string",
"optional": true
},
"health": {
"type": "string",
"optional": true
},
"classification": {
"type": "string",
"optional": true
},
"accountOwnerId": {
"type": "string",
"optional": true
},
"employees": {
"type": "number",
"optional": true
},
"annualRevenue": {
"type": "number",
"optional": true
},
"billingAddress": {
"type": "string",
"optional": true
},
"shippingAddress": {
"type": "string",
"optional": true
},
"secondaryDomain": {
"type": "string",
"optional": true
},
"customFieldValues": {
"type": "array",
"optional": true,
"items": {
"type": "object",
"properties": {
"customFieldId": {
"type": "string",
"required": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"required": true
},
"id": {
"type": "string"
}
}
}
}
}
}
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"description": "Unique identifier for the created account"
},
"name": {
"type": "string"
},
"primaryDomain": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"customFieldValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"customFieldId": {
"type": "string"
},
"data": {
"type": "object"
},
"metadata": {
"type": "object"
}
}
}
}
}
Scope: Organization
Source: Platform
Description: Creates an account activity
Request payload:
Copy
Ask AI
{
"accountId": {
"type": "string",
"required": true,
"description": "ID of the account to create activity for"
},
"activityTimestamp": {
"type": "string",
"required": true,
"description": "Timestamp of the activity"
},
"type": {
"type": "string",
"optional": true,
"description": "Type of activity"
},
"status": {
"type": "string",
"optional": true,
"description": "Status of activity"
},
"duration": {
"type": "number",
"optional": true,
"description": "Duration of activity"
},
"location": {
"type": "string",
"optional": true,
"description": "Location of activity"
},
"participants": {
"type": "array",
"optional": true,
"items": {
"type": "string"
},
"description": "List of participant IDs"
},
"attachmentUrls": {
"type": "array",
"optional": true,
"items": {
"type": "string"
},
"description": "List of attachment URLs"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string"
},
"accountId": {
"type": "string"
},
"account": {
"type": "string"
},
"type": {
"type": "string",
"optional": true
},
"status": {
"type": "string",
"optional": true
},
"duration": {
"type": "number",
"optional": true
},
"location": {
"type": "string",
"optional": true
},
"participants": {
"type": "array",
"items": {
"type": "string"
}
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "number"
},
"contentType": {
"type": "string"
}
}
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
Scope: Organization
Source: Platform
Description: Retrieves accounts with optional filtering
Request payload:
Copy
Ask AI
{
"page": {
"type": "number",
"optional": true,
"description": "Page number for pagination"
},
"limit": {
"type": "number",
"optional": true,
"description": "Number of records per page"
},
"health": {
"type": "string",
"optional": true,
"description": "Filter by account health"
},
"source": {
"type": "string",
"optional": true,
"description": "Filter by account source"
},
"status": {
"type": "string",
"optional": true,
"description": "Filter by account status"
},
"industry": {
"type": "string",
"optional": true,
"description": "Filter by industry"
},
"accountOwnerId": {
"type": "string",
"optional": true,
"description": "Filter by account owner"
},
"classification": {
"type": "string",
"optional": true,
"description": "Filter by classification"
}
}
Response payload:
Copy
Ask AI
{
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"primaryDomain",
"createdAt",
"updatedAt"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"primaryDomain": {
"type": "string"
},
"logo": {
"type": "string",
"optional": true
},
"website": {
"type": "string",
"optional": true
},
"description": {
"type": "string",
"optional": true
},
"industry": {
"type": "string",
"optional": true
},
"status": {
"type": "string",
"optional": true
},
"health": {
"type": "string",
"optional": true
},
"classification": {
"type": "string",
"optional": true
},
"accountOwnerId": {
"type": "string",
"optional": true
},
"accountOwnerEmail": {
"type": "string",
"optional": true
},
"employees": {
"type": "number",
"optional": true
},
"annualRevenue": {
"type": "number",
"optional": true
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"customFieldValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"customFieldId": {
"type": "string"
},
"data": {
"type": "object"
},
"metadata": {
"type": "object"
}
}
}
}
}
}
}
}
Scope: Organization
Source: Platform
Description: Updates an existing account
Request payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "Account ID to update"
},
"name": {
"type": "string",
"optional": true,
"description": "Account name"
},
"primaryDomain": {
"type": "string",
"optional": true,
"description": "Primary domain"
},
"logo": {
"type": "string",
"optional": true,
"description": "Logo URL"
},
"website": {
"type": "string",
"optional": true,
"description": "Website URL"
},
"description": {
"type": "string",
"optional": true,
"description": "Account description"
},
"industry": {
"type": "string",
"optional": true,
"description": "Industry name"
},
"status": {
"type": "string",
"optional": true,
"description": "Account status"
},
"health": {
"type": "string",
"optional": true,
"description": "Account health"
},
"classification": {
"type": "string",
"optional": true,
"description": "Account classification"
},
"accountOwnerId": {
"type": "string",
"optional": true,
"description": "Account owner user ID"
},
"employees": {
"type": "number",
"optional": true,
"description": "Number of employees"
},
"annualRevenue": {
"type": "number",
"optional": true,
"description": "Annual revenue"
},
"billingAddress": {
"type": "string",
"optional": true,
"description": "Billing address"
},
"shippingAddress": {
"type": "string",
"optional": true,
"description": "Shipping address"
},
"secondaryDomain": {
"type": "string",
"optional": true,
"description": "Secondary domain"
},
"customFieldValues": {
"type": "array",
"optional": true,
"items": {
"type": "object",
"properties": {
"customFieldId": {
"type": "string",
"required": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"required": true
}
}
}
}
}
}
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"primaryDomain": {
"type": "string"
},
"logo": {
"type": "string",
"optional": true
},
"website": {
"type": "string",
"optional": true
},
"description": {
"type": "string",
"optional": true
},
"industry": {
"type": "string",
"optional": true
},
"status": {
"type": "string",
"optional": true
},
"health": {
"type": "string",
"optional": true
},
"classification": {
"type": "string",
"optional": true
},
"accountOwnerId": {
"type": "string",
"optional": true
},
"accountOwnerEmail": {
"type": "string",
"optional": true
},
"employees": {
"type": "number",
"optional": true
},
"annualRevenue": {
"type": "number",
"optional": true
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"customFieldValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"customFieldId": {
"type": "string"
},
"data": {
"type": "object"
},
"metadata": {
"type": "object"
}
}
}
}
}
Scope: Organization
Source: Platform
Description: Deletes an account
Request payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "ID of the account to delete"
}
}
Response payload: Empty response on success
Scope: Organization
Source: Platform
Description: Manage account relationships and types
Available operations:
- Create/Update/Delete relationship
- Create/Update/Delete relationship type
- Get relationships and types
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Manage account activities
Available operations:
- Create activity
- Update activity
- Delete activity
- Get activities
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Creates a new note for an account
Request payload:
Copy
Ask AI
{
"accountId": {
"type": "string",
"required": true,
"description": "ID of the account to create note for"
},
"content": {
"type": "string",
"required": true,
"description": "Content of the note"
},
"type": {
"type": "string",
"optional": true,
"description": "Type of note"
},
"visibility": {
"type": "string",
"optional": true,
"description": "Visibility level of the note"
},
"attachmentUrls": {
"type": "array",
"optional": true,
"items": {
"type": "string"
},
"description": "List of attachment URLs"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"description": "Unique identifier for the created note"
},
"accountId": {
"type": "string",
"description": "ID of the account"
},
"account": {
"type": "string",
"description": "Account name"
},
"content": {
"type": "string",
"description": "Note content"
},
"type": {
"type": "string",
"optional": true,
"description": "Note type"
},
"visibility": {
"type": "string",
"description": "Note visibility"
},
"author": {
"type": "string",
"description": "Author name"
},
"authorId": {
"type": "string",
"description": "Author ID"
},
"authorEmail": {
"type": "string",
"description": "Author email"
},
"attachments": {
"type": "array",
"optional": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Attachment ID"
},
"url": {
"type": "string",
"description": "Attachment URL"
},
"name": {
"type": "string",
"description": "Attachment name"
},
"size": {
"type": "number",
"description": "Attachment size"
},
"contentType": {
"type": "string",
"description": "Attachment content type"
},
"createdAt": {
"type": "string",
"description": "Attachment creation timestamp"
}
}
}
},
"createdAt": {
"type": "string",
"description": "Creation timestamp"
},
"updatedAt": {
"type": "string",
"description": "Last update timestamp"
}
}
Scope: Organization
Source: Platform
Description: Updates an existing account note
Request payload:
Copy
Ask AI
{
"noteId": {
"type": "string",
"required": true,
"description": "ID of the note to update"
},
"content": {
"type": "string",
"optional": true,
"description": "New content for the note"
},
"type": {
"type": "string",
"optional": true,
"description": "New type for the note"
},
"visibility": {
"type": "string",
"optional": true,
"description": "New visibility level"
},
"attachmentUrls": {
"type": "array",
"optional": true,
"items": {
"type": "string"
},
"description": "New list of attachment URLs"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"description": "Note ID"
},
"accountId": {
"type": "string",
"description": "Account ID"
},
"account": {
"type": "string",
"description": "Account name"
},
"content": {
"type": "string",
"description": "Note content"
},
"type": {
"type": "string",
"optional": true,
"description": "Note type"
},
"visibility": {
"type": "string",
"description": "Note visibility"
},
"author": {
"type": "string",
"description": "Author name"
},
"authorId": {
"type": "string",
"description": "Author ID"
},
"authorEmail": {
"type": "string",
"description": "Author email"
},
"attachments": {
"type": "array",
"optional": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Attachment ID"
},
"url": {
"type": "string",
"description": "Attachment URL"
},
"name": {
"type": "string",
"description": "Attachment name"
},
"size": {
"type": "number",
"description": "Attachment size"
},
"contentType": {
"type": "string",
"description": "Attachment content type"
},
"createdAt": {
"type": "string",
"description": "Attachment creation timestamp"
}
}
}
},
"createdAt": {
"type": "string",
"description": "Creation timestamp"
},
"updatedAt": {
"type": "string",
"description": "Last update timestamp"
}
}
Scope: Organization
Source: Platform
Description: Deletes an account note
Request payload:
Copy
Ask AI
{
"noteId": {
"type": "string",
"required": true,
"description": "ID of the note to delete"
}
}
Response payload: Empty response on success
Scope: Organization
Source: Platform
Description: Retrieves notes for an account
Request payload:
Copy
Ask AI
{
"accountId": {
"type": "string",
"required": true,
"description": "ID of the account to get notes for"
},
"page": {
"type": "number",
"optional": true,
"description": "Page number for pagination"
},
"limit": {
"type": "number",
"optional": true,
"description": "Number of records per page"
},
"type": {
"type": "string",
"optional": true,
"description": "Filter notes by type"
},
"visibility": {
"type": "string",
"optional": true,
"description": "Filter notes by visibility"
}
}
Response payload:
Copy
Ask AI
{
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Note ID"
},
"accountId": {
"type": "string",
"description": "Account ID"
},
"account": {
"type": "string",
"description": "Account name"
},
"content": {
"type": "string",
"description": "Note content"
},
"type": {
"type": "string",
"optional": true,
"description": "Note type"
},
"typeId": {
"type": "string",
"optional": true,
"description": "Type ID"
},
"visibility": {
"type": "string",
"description": "Note visibility"
},
"author": {
"type": "string",
"description": "Author name"
},
"authorId": {
"type": "string",
"description": "Author ID"
},
"authorEmail": {
"type": "string",
"description": "Author email"
},
"attachments": {
"type": "array",
"optional": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Attachment ID"
},
"url": {
"type": "string",
"description": "Attachment URL"
},
"name": {
"type": "string",
"description": "Attachment name"
},
"size": {
"type": "number",
"description": "Attachment size"
},
"contentType": {
"type": "string",
"description": "Attachment content type"
},
"createdAt": {
"type": "string",
"description": "Attachment creation timestamp"
}
}
}
},
"metadata": {
"type": "object",
"optional": true,
"description": "Additional metadata"
},
"typeConfiguration": {
"type": "object",
"optional": true,
"description": "Type-specific configuration"
},
"createdAt": {
"type": "string",
"description": "Creation timestamp"
},
"updatedAt": {
"type": "string",
"description": "Last update timestamp"
}
}
}
}
}
Scope: Organization
Source: Platform
Description: Creates a new task for an account
Request payload:
Copy
Ask AI
{
"accountId": {
"type": "string",
"required": true,
"description": "ID of the account to create task for"
},
"title": {
"type": "string",
"required": true,
"description": "Task title"
},
"assigneeId": {
"type": "string",
"required": true,
"description": "ID of the user to assign the task to"
},
"type": {
"type": "string",
"optional": true,
"description": "Task type"
},
"status": {
"type": "string",
"optional": true,
"description": "Task status"
},
"priority": {
"type": "string",
"optional": true,
"description": "Task priority"
},
"description": {
"type": "string",
"optional": true,
"description": "Task description"
},
"activityId": {
"type": "string",
"optional": true,
"description": "Associated activity ID"
},
"attachmentUrls": {
"type": "array",
"optional": true,
"items": {
"type": "string"
},
"description": "List of attachment URLs"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"description": "Task ID"
},
"accountId": {
"type": "string",
"description": "Account ID"
},
"account": {
"type": "string",
"description": "Account name"
},
"title": {
"type": "string",
"description": "Task title"
},
"type": {
"type": "string",
"optional": true,
"description": "Task type"
},
"typeId": {
"type": "string",
"optional": true,
"description": "Type ID"
},
"status": {
"type": "string",
"optional": true,
"description": "Task status"
},
"statusId": {
"type": "string",
"optional": true,
"description": "Status ID"
},
"priority": {
"type": "string",
"optional": true,
"description": "Task priority"
},
"priorityId": {
"type": "string",
"optional": true,
"description": "Priority ID"
},
"description": {
"type": "string",
"optional": true,
"description": "Task description"
},
"creator": {
"type": "string",
"description": "Creator name"
},
"creatorId": {
"type": "string",
"description": "Creator ID"
},
"creatorEmail": {
"type": "string",
"description": "Creator email"
},
"assignee": {
"type": "string",
"optional": true,
"description": "Assignee name"
},
"assigneeId": {
"type": "string",
"optional": true,
"description": "Assignee ID"
},
"activityId": {
"type": "string",
"description": "Associated activity ID"
},
"attachments": {
"type": "array",
"optional": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Attachment ID"
},
"url": {
"type": "string",
"description": "Attachment URL"
},
"name": {
"type": "string",
"description": "Attachment name"
},
"size": {
"type": "number",
"description": "Attachment size"
},
"contentType": {
"type": "string",
"description": "Attachment content type"
},
"createdAt": {
"type": "string",
"description": "Attachment creation timestamp"
}
}
}
},
"metadata": {
"type": "object",
"optional": true,
"description": "Additional metadata"
},
"typeConfiguration": {
"type": "object",
"optional": true,
"description": "Type-specific configuration"
},
"statusConfiguration": {
"type": "object",
"optional": true,
"description": "Status-specific configuration"
},
"priorityConfiguration": {
"type": "object",
"optional": true,
"description": "Priority-specific configuration"
},
"createdAt": {
"type": "string",
"description": "Creation timestamp"
},
"updatedAt": {
"type": "string",
"description": "Last update timestamp"
}
}
Scope: Organization
Source: Platform
Description: Updates an existing account task
Request payload:
Copy
Ask AI
{
"taskId": {
"type": "string",
"required": true,
"description": "ID of the task to update"
},
"title": {
"type": "string",
"optional": true,
"description": "New task title"
},
"type": {
"type": "string",
"optional": true,
"description": "New task type"
},
"status": {
"type": "string",
"optional": true,
"description": "New task status"
},
"priority": {
"type": "string",
"optional": true,
"description": "New task priority"
},
"assigneeId": {
"type": "string",
"optional": true,
"description": "New assignee ID"
},
"description": {
"type": "string",
"optional": true,
"description": "New task description"
},
"activityId": {
"type": "string",
"optional": true,
"description": "New associated activity ID"
},
"attachmentUrls": {
"type": "array",
"optional": true,
"items": {
"type": "string"
},
"description": "New list of attachment URLs"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"description": "Task ID"
},
"accountId": {
"type": "string",
"description": "Account ID"
},
"account": {
"type": "string",
"description": "Account name"
},
"title": {
"type": "string",
"description": "Task title"
},
"type": {
"type": "string",
"optional": true,
"description": "Task type"
},
"typeId": {
"type": "string",
"optional": true,
"description": "Type ID"
},
"status": {
"type": "string",
"optional": true,
"description": "Task status"
},
"statusId": {
"type": "string",
"optional": true,
"description": "Status ID"
},
"priority": {
"type": "string",
"optional": true,
"description": "Task priority"
},
"priorityId": {
"type": "string",
"optional": true,
"description": "Priority ID"
},
"description": {
"type": "string",
"optional": true,
"description": "Task description"
},
"creator": {
"type": "string",
"description": "Creator name"
},
"creatorId": {
"type": "string",
"description": "Creator ID"
},
"creatorEmail": {
"type": "string",
"description": "Creator email"
},
"assignee": {
"type": "string",
"optional": true,
"description": "Assignee name"
},
"assigneeId": {
"type": "string",
"optional": true,
"description": "Assignee ID"
},
"activityId": {
"type": "string",
"description": "Associated activity ID"
},
"attachments": {
"type": "array",
"optional": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Attachment ID"
},
"url": {
"type": "string",
"description": "Attachment URL"
},
"name": {
"type": "string",
"description": "Attachment name"
},
"size": {
"type": "number",
"description": "Attachment size"
},
"contentType": {
"type": "string",
"description": "Attachment content type"
},
"createdAt": {
"type": "string",
"description": "Attachment creation timestamp"
}
}
}
},
"metadata": {
"type": "object",
"optional": true,
"description": "Additional metadata"
},
"typeConfiguration": {
"type": "object",
"optional": true,
"description": "Type-specific configuration"
},
"statusConfiguration": {
"type": "object",
"optional": true,
"description": "Status-specific configuration"
},
"priorityConfiguration": {
"type": "object",
"optional": true,
"description": "Priority-specific configuration"
},
"createdAt": {
"type": "string",
"description": "Creation timestamp"
},
"updatedAt": {
"type": "string",
"description": "Last update timestamp"
}
}
Scope: Organization
Source: Platform
Description: Deletes an account task
Request payload:
Copy
Ask AI
{
"taskId": {
"type": "string",
"required": true,
"description": "ID of the task to delete"
}
}
Response payload: Empty response on success
Scope: Organization
Source: Platform
Description: Retrieves tasks for an account
Request payload:
Copy
Ask AI
{
"accountId": {
"type": "string",
"required": true,
"description": "ID of the account to get tasks for"
},
"page": {
"type": "number",
"optional": true,
"description": "Page number for pagination"
},
"limit": {
"type": "number",
"optional": true,
"description": "Number of records per page"
},
"type": {
"type": "string",
"optional": true,
"description": "Filter by task type"
},
"status": {
"type": "string",
"optional": true,
"description": "Filter by task status"
},
"priority": {
"type": "string",
"optional": true,
"description": "Filter by task priority"
},
"assigneeId": {
"type": "string",
"optional": true,
"description": "Filter by assignee ID"
},
"activityId": {
"type": "string",
"optional": true,
"description": "Filter by associated activity ID"
}
}
Response payload:
Copy
Ask AI
{
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"accountId",
"account",
"title",
"createdAt",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"description": "Task ID"
},
"accountId": {
"type": "string",
"description": "Account ID"
},
"account": {
"type": "string",
"description": "Account name"
},
"title": {
"type": "string",
"description": "Task title"
},
"type": {
"type": "string",
"optional": true,
"description": "Task type"
},
"typeId": {
"type": "string",
"optional": true,
"description": "Type ID"
},
"status": {
"type": "string",
"optional": true,
"description": "Task status"
},
"statusId": {
"type": "string",
"optional": true,
"description": "Status ID"
},
"priority": {
"type": "string",
"optional": true,
"description": "Task priority"
},
"priorityId": {
"type": "string",
"optional": true,
"description": "Priority ID"
},
"description": {
"type": "string",
"optional": true,
"description": "Task description"
},
"creator": {
"type": "string",
"description": "Creator name"
},
"creatorId": {
"type": "string",
"description": "Creator ID"
},
"creatorEmail": {
"type": "string",
"description": "Creator email"
},
"assignee": {
"type": "string",
"optional": true,
"description": "Assignee name"
},
"assigneeId": {
"type": "string",
"optional": true,
"description": "Assignee ID"
},
"activityId": {
"type": "string",
"description": "Associated activity ID"
},
"attachments": {
"type": "array",
"optional": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Attachment ID"
},
"url": {
"type": "string",
"description": "Attachment URL"
},
"name": {
"type": "string",
"description": "Attachment name"
},
"size": {
"type": "number",
"description": "Attachment size"
},
"contentType": {
"type": "string",
"description": "Attachment content type"
},
"createdAt": {
"type": "string",
"description": "Attachment creation timestamp"
}
}
}
},
"metadata": {
"type": "object",
"optional": true,
"description": "Additional metadata"
},
"typeConfiguration": {
"type": "object",
"optional": true,
"description": "Type-specific configuration"
},
"statusConfiguration": {
"type": "object",
"optional": true,
"description": "Status-specific configuration"
},
"priorityConfiguration": {
"type": "object",
"optional": true,
"description": "Priority-specific configuration"
},
"createdAt": {
"type": "string",
"description": "Creation timestamp"
},
"updatedAt": {
"type": "string",
"description": "Last update timestamp"
}
}
}
}
}
Scope: Organization
Source: Platform
Description: Retrieves relationships for an account
Request payload:
Copy
Ask AI
{
"accountId": {
"type": "string",
"required": true,
"description": "ID of the account to get relationships for"
},
"page": {
"type": "number",
"optional": true,
"description": "Page number for pagination"
},
"limit": {
"type": "number",
"optional": true,
"description": "Number of records per page"
},
"relationshipType": {
"type": "string",
"optional": true,
"description": "Filter by relationship type"
}
}
Response payload:
Copy
Ask AI
{
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"accountId": {
"type": "string"
},
"account": {
"type": "string"
},
"relatedAccountId": {
"type": "string"
},
"relatedAccount": {
"type": "string"
},
"relationshipType": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"inverseRelationship": {
"type": "string",
"optional": true
},
"inverseRelationshipId": {
"type": "string",
"optional": true
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
}
}
}
Scope: Organization
Source: Platform
Description: Creates a relationship between two accounts
Request payload:
Copy
Ask AI
{
"accountId": {
"type": "string",
"required": true,
"description": "ID of the first account"
},
"relatedAccountId": {
"type": "string",
"required": true,
"description": "ID of the second account"
},
"relationshipType": {
"type": "string",
"required": true,
"description": "Type of relationship to create"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string"
},
"accountId": {
"type": "string"
},
"account": {
"type": "string"
},
"relatedAccountId": {
"type": "string"
},
"relatedAccount": {
"type": "string"
},
"relationshipType": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"inverseRelationship": {
"type": "string",
"optional": true
},
"inverseRelationshipId": {
"type": "string",
"optional": true
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
Scope: Organization
Source: Platform
Description: Updates an existing account relationship
Request payload:
Copy
Ask AI
{
"relationshipId": {
"type": "string",
"required": true,
"description": "ID of the relationship to update"
},
"relationshipType": {
"type": "string",
"optional": true,
"description": "New relationship type"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string"
},
"accountId": {
"type": "string"
},
"account": {
"type": "string"
},
"relatedAccountId": {
"type": "string"
},
"relatedAccount": {
"type": "string"
},
"relationshipType": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"inverseRelationship": {
"type": "string",
"optional": true
},
"inverseRelationshipId": {
"type": "string",
"optional": true
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
Scope: Organization
Source: Platform
Description: Deletes an account relationship
Request payload:
Copy
Ask AI
{
"relationshipId": {
"type": "string",
"required": true,
"description": "ID of the relationship to delete"
}
}
Response payload: Empty response on success
Customer contact management
Scope: Organization
Source: Platform
Description: Creates a new customer contact
Request payload:
Copy
Ask AI
{
"firstName": {
"type": "string",
"required": true,
"description": "First name of the contact"
},
"email": {
"type": "string",
"required": true,
"description": "Email address of the contact"
},
"lastName": {
"type": "string",
"required": false,
"description": "Last name of the contact"
},
"phoneNumber": {
"type": "string",
"required": false,
"description": "Phone number of the contact"
},
"contactType": {
"type": "string",
"required": false,
"description": "Type of contact"
},
"accountIds": {
"type": "array",
"required": false,
"description": "Array of account IDs to associate with the contact",
"items": {
"type": "string"
}
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "Unique identifier of the created contact"
},
"firstName": {
"type": "string",
"required": true,
"description": "First name of the contact"
},
"email": {
"type": "string",
"required": true,
"description": "Email address of the contact"
},
"lastName": {
"type": "string",
"required": false,
"description": "Last name of the contact"
},
"phoneNumber": {
"type": "string",
"required": false,
"description": "Phone number of the contact"
},
"contactType": {
"type": "string",
"required": false,
"description": "Type of contact"
},
"contactTypeId": {
"type": "string",
"required": false,
"description": "ID of the contact type"
},
"accounts": {
"type": "array",
"required": false,
"description": "Associated accounts",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Account ID"
},
"name": {
"type": "string",
"description": "Account name"
}
}
}
},
"createdAt": {
"type": "string",
"required": true,
"description": "Contact creation timestamp"
},
"updatedAt": {
"type": "string",
"required": true,
"description": "Last update timestamp"
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Updates an existing customer contact
Request payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "ID of the contact to update"
},
"firstName": {
"type": "string",
"required": false,
"description": "New first name of the contact"
},
"email": {
"type": "string",
"required": false,
"description": "New email address of the contact"
},
"lastName": {
"type": "string",
"required": false,
"description": "New last name of the contact"
},
"phoneNumber": {
"type": "string",
"required": false,
"description": "New phone number of the contact"
},
"contactType": {
"type": "string",
"required": false,
"description": "New type of contact"
},
"accountIds": {
"type": "array",
"required": false,
"description": "New array of account IDs to associate with the contact",
"items": {
"type": "string"
}
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "Unique identifier of the contact"
},
"firstName": {
"type": "string",
"required": true,
"description": "First name of the contact"
},
"email": {
"type": "string",
"required": true,
"description": "Email address of the contact"
},
"lastName": {
"type": "string",
"required": false,
"description": "Last name of the contact"
},
"phoneNumber": {
"type": "string",
"required": false,
"description": "Phone number of the contact"
},
"contactType": {
"type": "string",
"required": false,
"description": "Type of contact"
},
"contactTypeId": {
"type": "string",
"required": false,
"description": "ID of the contact type"
},
"accounts": {
"type": "array",
"required": false,
"description": "Associated accounts",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Account ID"
},
"name": {
"type": "string",
"description": "Account name"
}
}
}
},
"createdAt": {
"type": "string",
"required": true,
"description": "Contact creation timestamp"
},
"updatedAt": {
"type": "string",
"required": true,
"description": "Last update timestamp"
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Deletes a customer contact
Request payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "ID of the contact to delete"
}
}
Response payload: Empty response on success
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Retrieves customer contacts with optional filtering
Request payload:
Copy
Ask AI
{
"page": {
"type": "number",
"required": false,
"description": "Page number for pagination"
},
"limit": {
"type": "number",
"required": false,
"description": "Number of contacts per page"
},
"email": {
"type": "string",
"required": false,
"description": "Filter by email address"
},
"accountId": {
"type": "string",
"required": false,
"description": "Filter by associated account ID"
},
"contactType": {
"type": "string",
"required": false,
"description": "Filter by contact type"
}
}
Response payload:
Copy
Ask AI
{
"data": {
"type": "array",
"required": true,
"description": "Array of contact objects",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"required": true,
"description": "Contact ID"
},
"firstName": {
"type": "string",
"required": true,
"description": "First name of the contact"
},
"email": {
"type": "string",
"required": true,
"description": "Email address of the contact"
},
"lastName": {
"type": "string",
"required": false,
"description": "Last name of the contact"
},
"phoneNumber": {
"type": "string",
"required": false,
"description": "Phone number of the contact"
},
"contactType": {
"type": "string",
"required": false,
"description": "Type of contact"
},
"contactTypeId": {
"type": "string",
"required": false,
"description": "ID of the contact type"
},
"accounts": {
"type": "array",
"required": false,
"description": "Associated accounts",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Account ID"
},
"name": {
"type": "string",
"description": "Account name"
}
}
}
},
"createdAt": {
"type": "string",
"required": true,
"description": "Contact creation timestamp"
},
"updatedAt": {
"type": "string",
"required": true,
"description": "Last update timestamp"
}
}
}
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Creates multiple customer contacts in a single operation
Request payload:
Copy
Ask AI
{
"contacts": {
"type": "array",
"required": true,
"description": "Array of contact objects to create",
"items": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"required": true,
"description": "First name of the contact"
},
"email": {
"type": "string",
"required": true,
"description": "Email address of the contact"
},
"lastName": {
"type": "string",
"required": false,
"description": "Last name of the contact"
},
"phoneNumber": {
"type": "string",
"required": false,
"description": "Phone number of the contact"
},
"contactType": {
"type": "string",
"required": false,
"description": "Type of contact"
},
"accountIds": {
"type": "array",
"required": false,
"description": "Array of account IDs to associate with the contact",
"items": {
"type": "string"
}
}
}
}
}
}
Response payload:
Copy
Ask AI
{
"data": {
"type": "array",
"required": true,
"description": "Array of created contact objects",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"required": true,
"description": "Contact ID"
},
"firstName": {
"type": "string",
"required": true,
"description": "First name of the contact"
},
"email": {
"type": "string",
"required": true,
"description": "Email address of the contact"
},
"lastName": {
"type": "string",
"required": false,
"description": "Last name of the contact"
},
"phoneNumber": {
"type": "string",
"required": false,
"description": "Phone number of the contact"
},
"contactType": {
"type": "string",
"required": false,
"description": "Type of contact"
},
"contactTypeId": {
"type": "string",
"required": false,
"description": "ID of the contact type"
},
"accounts": {
"type": "array",
"required": false,
"description": "Associated accounts",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Account ID"
},
"name": {
"type": "string",
"description": "Account name"
}
}
}
},
"createdAt": {
"type": "string",
"required": true,
"description": "Contact creation timestamp"
},
"updatedAt": {
"type": "string",
"required": true,
"description": "Last update timestamp"
}
}
}
}
}
Connection details: Platform API
Utilities
Scope: Organization
Source: Platform
Description: Waits for a specified duration
Request payload:
Copy
Ask AI
{
"duration": {
"type": "number",
"required": true,
"description": "Duration to sleep in milliseconds"
}
}
Response payload:
Copy
Ask AI
{
"data": {
"type": "string",
"required": true,
"description": "Response data"
},
"status": {
"type": "number",
"required": true,
"description": "HTTP status code"
},
"sleep_duration": {
"type": "number",
"required": true,
"description": "Actual duration slept in milliseconds"
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Triggers another workflow
Request payload:
Copy
Ask AI
{
"workflowUniqueIdentifier": {
"type": "string",
"required": true,
"description": "Unique identifier of the workflow to trigger"
},
"data": {
"type": "object",
"required": true,
"description": "Input data for the triggered workflow"
}
}
Response payload:
Copy
Ask AI
{
"data": {
"type": "string",
"required": true,
"description": "Result of the workflow trigger operation"
},
"status": {
"type": "number",
"required": true,
"description": "HTTP status code of the operation"
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Checks team availability based on holidays and business hours
Request payload:
Copy
Ask AI
{
"teamId": {
"type": "string",
"required": true,
"description": "ID of the team to check availability for (can be null for organization-wide check)"
}
}
Response payload:
Copy
Ask AI
{
"isAvailable": {
"type": "boolean",
"required": true,
"description": "Whether the team is currently available"
},
"reason": {
"type": "string",
"required": true,
"description": "Reason for availability status",
"enum": ["IN_BUSINESS_HOURS", "OUTSIDE_BUSINESS_HOURS", "HOLIDAY"]
}
}
Connection details: Platform API
Scope: Organization
Source: Platform
Description: Checks user availability based on time off and business hours
Request payload:
Copy
Ask AI
{
"userId": {
"type": "string",
"required": true,
"description": "ID of the user to check availability for (can be null for current user)"
}
}
Response payload:
Copy
Ask AI
{
"isAvailable": {
"type": "boolean",
"required": true,
"description": "Whether the user is currently available"
},
"reason": {
"type": "string",
"required": true,
"description": "Reason for availability status",
"enum": ["IN_BUSINESS_HOURS", "OUTSIDE_BUSINESS_HOURS", "TIME_OFF"]
}
}
Connection details: Platform API
Integration activities
Slack integration
Scope: Organization
Source: Registered App
Description: Posts a message to a Slack channel or user
Request payload:
Copy
Ask AI
{
"channel": {
"type": "string",
"required": true,
"description": "Channel ID or user ID to send message to"
},
"text": {
"type": "string",
"required": true,
"description": "Message text content"
},
"blocks": {
"type": "array",
"required": false,
"description": "Optional Slack block kit elements"
},
"thread_ts": {
"type": "string",
"required": false,
"description": "Optional timestamp of parent message for threading"
}
}
Response payload:
Copy
Ask AI
{
"ok": {
"type": "boolean",
"description": "Whether the operation was successful"
},
"ts": {
"type": "string",
"description": "Timestamp of the posted message"
},
"channel": {
"type": "string",
"description": "Channel ID where message was posted"
},
"message": {
"type": "object",
"description": "Full message object"
}
}
Connection: HTTP (Slack API)
Scope: Organization
Source: Registered App
Description: Edits an existing Slack message
Request payload:
Copy
Ask AI
{
"channel": {
"type": "string",
"required": true,
"description": "Channel ID containing the message"
},
"ts": {
"type": "string",
"required": true,
"description": "Timestamp of message to edit"
},
"text": {
"type": "string",
"required": true,
"description": "New message text"
},
"blocks": {
"type": "array",
"required": false,
"description": "Optional updated block kit elements"
}
}
Response payload:
Copy
Ask AI
{
"ok": {
"type": "boolean",
"description": "Whether the operation was successful"
},
"ts": {
"type": "string",
"description": "Timestamp of the edited message"
},
"text": {
"type": "string",
"description": "Updated message text"
},
"channel": {
"type": "string",
"description": "Channel ID containing the message"
}
}
Connection: HTTP (Slack API)
Scope: Organization
Source: Registered App
Description: Deletes a Slack message
Request payload:
Copy
Ask AI
{
"channel": {
"type": "string",
"required": true,
"description": "Channel ID containing the message"
},
"ts": {
"type": "string",
"required": true,
"description": "Timestamp of message to delete"
}
}
Response payload:
Copy
Ask AI
{
"ok": {
"type": "boolean",
"description": "Whether the operation was successful"
},
"ts": {
"type": "string",
"description": "Timestamp of the deleted message"
},
"channel": {
"type": "string",
"description": "Channel ID containing the message"
}
}
Connection: HTTP (Slack API)
Scope: Organization
Source: Registered App
Description: Joins a Slack channel
Request payload:
Copy
Ask AI
{
"channel": {
"type": "string",
"required": true,
"description": "Channel ID to join"
}
}
Response payload:
Copy
Ask AI
{
"ok": {
"type": "boolean",
"description": "Whether the operation was successful"
},
"channel": {
"type": "object",
"description": "Channel object that was joined"
}
}
Connection: HTTP (Slack API)
Scope: Organization
Source: Registered App
Description: Leaves a Slack channel
Request payload:
Copy
Ask AI
{
"channel": {
"type": "string",
"required": true,
"description": "Channel ID to leave"
}
}
Response payload:
Copy
Ask AI
{
"ok": {
"type": "boolean",
"description": "Whether the operation was successful"
}
}
Connection: HTTP (Slack API)
Scope: Organization
Source: Registered App
Description: Adds a member to a Slack channel
Request payload:
Copy
Ask AI
{
"channel": {
"type": "string",
"required": true,
"description": "Channel ID"
},
"user": {
"type": "string",
"required": true,
"description": "User ID to add"
}
}
Response payload:
Copy
Ask AI
{
"ok": {
"type": "boolean",
"description": "Whether the operation was successful"
}
}
Connection: HTTP (Slack API)
Scope: Organization
Source: Registered App
Description: Removes a member from a Slack channel
Request payload:
Copy
Ask AI
{
"channel": {
"type": "string",
"required": true,
"description": "Channel ID"
},
"user": {
"type": "string",
"required": true,
"description": "User ID to remove"
}
}
Response payload:
Copy
Ask AI
{
"ok": {
"type": "boolean",
"description": "Whether the operation was successful"
}
}
Connection: HTTP (Slack API)
Scope: Organization
Source: Registered App
Description: Adds a reaction to a Slack message
Request payload:
Copy
Ask AI
{
"channel": {
"type": "string",
"required": true,
"description": "Channel ID containing the message"
},
"ts": {
"type": "string",
"required": true,
"description": "Timestamp of target message"
},
"name": {
"type": "string",
"required": true,
"description": "Emoji name without colons (e.g., 'thumbsup')"
}
}
Response payload:
Copy
Ask AI
{
"ok": {
"type": "boolean",
"description": "Whether the operation was successful"
}
}
Connection: HTTP (Slack API)
Scope: Organization
Source: Registered App
Description: Removes a reaction from a Slack message
Request payload:
Copy
Ask AI
{
"channel": {
"type": "string",
"required": true,
"description": "Channel ID containing the message"
},
"ts": {
"type": "string",
"required": true,
"description": "Timestamp of target message"
},
"name": {
"type": "string",
"required": true,
"description": "Emoji name to remove"
}
}
Response payload:
Copy
Ask AI
{
"ok": {
"type": "boolean",
"description": "Whether the operation was successful"
}
}
Connection: HTTP (Slack API)
Jira integration
Scope: Organization
Source: Registered App
Description: Creates a new issue in Jira
Request payload:
Copy
Ask AI
{
"summary": {
"type": "string",
"required": true,
"description": "Issue summary/title"
},
"issue_type": {
"type": "string",
"required": true,
"description": "Jira issue type ID (e.g., 'Bug', 'Task', 'Story')"
},
"description": {
"type": "string",
"required": true,
"description": "Detailed description of the issue"
},
"project_key": {
"type": "string",
"required": true,
"description": "Jira project key (e.g., 'PROJ', 'DEV')"
}
}
Response payload:
Copy
Ask AI
{
"id": {
"type": "string",
"description": "Unique identifier of the created issue"
},
"key": {
"type": "string",
"description": "Issue key (e.g., 'PROJ-123')"
},
"self": {
"type": "string",
"description": "URL to the created issue"
},
"metadata": {
"type": "object",
"description": "Additional information about the created issue"
}
}
Connection: HTTP (Jira API)
Scope: Organization
Source: Registered App
Description: Transitions a Jira issue to a different status
Request payload:
Copy
Ask AI
{
"issue_key": {
"type": "string",
"required": true,
"description": "Jira issue key (e.g., 'PROJ-123')"
},
"transition_id": {
"type": "string",
"required": true,
"description": "Transition ID to execute (e.g., '21' for 'In Progress', '31' for 'Done')"
}
}
Response payload:
Copy
Ask AI
{
"success": {
"type": "boolean",
"description": "Whether the transition was successful"
},
"metadata": {
"type": "object",
"description": "Additional information about the transition"
}
}
Connection: HTTP (Jira API)
AI agent activities
Scope: Team
Source: Registered App
Description: Changes ticket status based on AI analysis of comments and context
Request payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "ID of the ticket to analyze for status change"
}
}
Response payload:
Copy
Ask AI
{
"success": {
"type": "boolean",
"description": "Whether the status change was successful"
},
"new_status": {
"type": "string",
"description": "The new status assigned to the ticket"
},
"confidence": {
"type": "number",
"description": "AI confidence score for the status change decision"
},
"reasoning": {
"type": "string",
"description": "AI reasoning for the status change"
}
}
Connection: HTTP (Agent Studio API)
Scope: Organization
Source: Registered App
Description: Analyzes tickets for potential deflection opportunities using AI
Request payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "ID of the ticket to analyze for deflection"
}
}
Response payload:
Copy
Ask AI
{
"output": {
"type": "object",
"description": "AI analysis results for ticket deflection",
"properties": {
"can_deflect": {
"type": "boolean",
"description": "Whether the ticket can be deflected"
},
"deflection_confidence": {
"type": "number",
"description": "Confidence score for deflection recommendation"
},
"suggested_resources": {
"type": "array",
"items": {
"type": "string"
},
"description": "Suggested knowledge base articles or resources"
},
"deflection_reason": {
"type": "string",
"description": "Reason why the ticket can or cannot be deflected"
}
}
}
}
Connection: HTTP (Agent Studio API)
Scope: Organization
Source: Registered App
Description: Generates AI-powered summaries for ticket content and context
Request payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "Ticket ID"
},
"title": {
"type": "string",
"required": true,
"description": "Ticket title"
},
"description": {
"type": "string",
"required": false,
"description": "Ticket description"
},
"teamId": {
"type": "string",
"required": true,
"description": "Team ID"
},
"customer": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "string",
"description": "Customer ID"
},
"name": {
"type": "string",
"description": "Customer name"
},
"email": {
"type": "string",
"required": true,
"description": "Customer email"
}
}
},
"statusId": {
"type": "string",
"required": false,
"description": "Current status ID"
},
"statusName": {
"type": "string",
"required": false,
"description": "Current status name"
},
"priorityId": {
"type": "string",
"required": false,
"description": "Priority ID"
},
"priorityName": {
"type": "string",
"required": false,
"description": "Priority name"
},
"assignedTo": {
"type": "string",
"required": false,
"description": "Assigned agent ID"
},
"assignedName": {
"type": "string",
"required": false,
"description": "Assigned agent name"
},
"source": {
"type": "string",
"required": false,
"description": "Ticket source"
},
"tags": {
"type": "array",
"required": true,
"items": {
"type": "string"
},
"description": "Ticket tags"
},
"isArchived": {
"type": "boolean",
"required": true,
"description": "Whether ticket is archived"
},
"isEscalated": {
"type": "boolean",
"required": true,
"description": "Whether ticket is escalated"
},
"createdAt": {
"type": "string",
"required": true,
"description": "Ticket creation timestamp"
},
"metadata": {
"type": "object",
"required": false,
"description": "Additional ticket metadata"
},
"customFields": {
"type": "array",
"required": false,
"items": {
"type": "object"
},
"description": "Custom field values"
}
}
Response payload:
Copy
Ask AI
{
"output": {
"type": "object",
"required": true,
"properties": {
"key_points": {
"type": "array",
"items": {
"type": "string"
},
"description": "3-5 key points extracted from the ticket"
},
"customer_summary": {
"type": "string",
"description": "Customer-friendly, non-technical summary"
},
"technical_summary": {
"type": "string",
"description": "Technical summary with internal context"
}
}
}
}
Connection: HTTP (Agent Studio API)
Scope: Organization
Source: Registered App
Description: Generates optimized titles and descriptions for tickets using AI
Request payload:
Copy
Ask AI
{
"id": {
"type": "string",
"required": true,
"description": "Ticket ID"
},
"title": {
"type": "string",
"required": true,
"description": "Current ticket title"
},
"description": {
"type": "string",
"required": false,
"description": "Current ticket description"
},
"teamId": {
"type": "string",
"required": true,
"description": "Team ID"
},
"customer": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "string",
"description": "Customer ID"
},
"name": {
"type": "string",
"description": "Customer name"
},
"email": {
"type": "string",
"required": true,
"description": "Customer email"
}
}
},
"statusId": {
"type": "string",
"required": false,
"description": "Current status ID"
},
"statusName": {
"type": "string",
"required": false,
"description": "Current status name"
},
"priorityId": {
"type": "string",
"required": false,
"description": "Priority ID"
},
"priorityName": {
"type": "string",
"required": false,
"description": "Priority name"
},
"assignedTo": {
"type": "string",
"required": false,
"description": "Assigned agent ID"
},
"assignedName": {
"type": "string",
"required": false,
"description": "Assigned agent name"
},
"source": {
"type": "string",
"required": false,
"description": "Ticket source"
},
"tags": {
"type": "array",
"required": true,
"items": {
"type": "string"
},
"description": "Ticket tags"
},
"isArchived": {
"type": "boolean",
"required": true,
"description": "Whether ticket is archived"
},
"isEscalated": {
"type": "boolean",
"required": true,
"description": "Whether ticket is escalated"
},
"createdAt": {
"type": "string",
"required": true,
"description": "Ticket creation timestamp"
},
"metadata": {
"type": "object",
"required": false,
"description": "Additional ticket metadata"
},
"customFields": {
"type": "array",
"required": false,
"items": {
"type": "object"
},
"description": "Custom field values"
}
}
Response payload:
Copy
Ask AI
{
"output": {
"type": "object",
"required": true,
"properties": {
"title": {
"type": "string",
"description": "Optimized and clear title for the ticket"
},
"description": {
"type": "string",
"description": "Well-structured and detailed description"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "Relevant keywords for ticket categorization"
},
"confidence_scores": {
"type": "object",
"properties": {
"title": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "Confidence score for the generated title"
},
"description": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "Confidence score for the generated description"
}
}
}
}
}
}
Connection: HTTP (Agent Studio API)
Best practices
1
Activity design
- Keep activities focused and single-purpose
- Define clear input/output contracts
- Implement proper validation
- Handle errors gracefully
2
Security
- Validate all inputs
- Check required permissions
- Secure sensitive data
- Audit activity execution
3
Performance
- Configure appropriate rate limits
- Implement proper timeouts
- Monitor resource usage
- Handle concurrent executions
Related resources
On this page
- Understanding activities
- Activity types
- Activity anatomy
- Core properties
- Schema structure
- Core platform activities
- Ticket management
- Comment management
- Account management
- Customer contact management
- Utilities
- Integration activities
- Slack integration
- Jira integration
- AI agent activities
- Best practices
- Related resources
Assistant
Responses are generated using AI and may contain mistakes.