AgentService11

AppService22

AuditLogService11

ChatService38

ConnectorService17

DashboardService24

DatasetService14

MCPService7

MetricsExportService5

ObservabilityService30

OntologyManagementService69

PlaybookService39

PowerBIService10

RBACService49

SandboxAdminService9

SandboxCapabilityService4

SandboxQueryService1

ScimService6

SecretService5

SlackService2

textql.rpc.platform.AgentService1

post/v1/agents/webhook/triggerTriggerAgentWebhook

textql.rpc.platform.ApiAccessKeyService5

textql.rpc.platform.ChatService4

textql.rpc.platform.ConnectorService1

textql.rpc.platform.PlaybookService7

textql.rpc.platform.SandboxService6

textql.rpc.platform.AgentService

TriggerAgentWebhook

Trigger an agent run with a JSON webhook payload

post/v1/agents/webhook/trigger

Request

The document declares no server URL.
Auth
none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

triggerIdstring uuid required

The webhook trigger ID for the agent.

payloadobject

JSON payload to pass to the agent as run context. Limited to 16KB after JSON serialization.

Response

Success

statusstring

Queue status for the agent run.

Example response

{
  "status": "queued"
}

Changes

No recorded changes to this operation across all 1 revision of this API.