API Reference

Webhooks

Copy page

Webhook endpoints

Invoke agent via trigger webhook

POST
/run/tenants/{tenantId}/projects/{projectId}/agents/{agentId}/triggers/{triggerId}

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Path Parameters

tenantId*string

Tenant ID

projectId*string

Project ID

agentId*string

Agent ID

triggerId*string

Trigger ID

Request Body

application/json

[key: string]?unknown

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.pilot.inkeep.com/run/tenants/string/projects/string/agents/string/triggers/string" \  -H "Content-Type: application/json" \  -d '{    "property1": null,    "property2": null  }'
{
  "conversationId": "string",
  "invocationId": "string",
  "success": true
}
{
  "error": "string",
  "validationErrors": [
    "string"
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}