Triggers
Copy page
Operations for managing triggers
List Triggers
Authorization
bearerAuth cookieAuth Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
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
Tenant identifier
Project identifier
Agent identifier
Query Parameters
11 <= value101 <= value <= 100Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://api.pilot.inkeep.com/manage/tenants/tenant_123/projects/project_456/agents/agent_789/triggers"{
"data": [
{
"authentication": "string",
"createdAt": "string",
"description": "string",
"enabled": true,
"id": "string",
"inputSchema": "string",
"messageTemplate": "string",
"name": "string",
"outputTransform": "string",
"signatureVerification": {
"algorithm": "sha256",
"componentJoin": {
"separator": "string",
"strategy": "concatenate"
},
"encoding": "hex",
"signature": {
"key": "string",
"prefix": "string",
"regex": "string",
"source": "header"
},
"signedComponents": [
{
"key": "string",
"regex": "string",
"required": true,
"source": "header",
"value": "string"
}
],
"validation": {
"allowEmptyBody": true,
"headerCaseSensitive": false,
"normalizeUnicode": false
}
},
"signingSecretCredentialReferenceId": "string",
"updatedAt": "string",
"webhookUrl": "string"
}
],
"pagination": {
"limit": 10,
"page": 1,
"pages": 0,
"total": 0
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Create Trigger
Authorization
bearerAuth cookieAuth Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
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
Tenant identifier
Project identifier
Agent identifier
Request Body
application/json
Trigger description
Whether the trigger is enabled
trueResource identifier
^[a-zA-Z0-9\-_.]+$1 <= length <= 255JSON Schema for input validation
Message template with {{placeholder}} syntax
1 <= lengthTrigger name
1 <= lengthConfiguration for webhook signature verification
Reference to credential containing signing secret
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://api.pilot.inkeep.com/manage/tenants/tenant_123/projects/project_456/agents/agent_789/triggers" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{
"data": {
"authentication": "string",
"createdAt": "string",
"description": "string",
"enabled": true,
"id": "string",
"inputSchema": "string",
"messageTemplate": "string",
"name": "string",
"outputTransform": "string",
"signatureVerification": {
"algorithm": "sha256",
"componentJoin": {
"separator": "string",
"strategy": "concatenate"
},
"encoding": "hex",
"signature": {
"key": "string",
"prefix": "string",
"regex": "string",
"source": "header"
},
"signedComponents": [
{
"key": "string",
"regex": "string",
"required": true,
"source": "header",
"value": "string"
}
],
"validation": {
"allowEmptyBody": true,
"headerCaseSensitive": false,
"normalizeUnicode": false
}
},
"signingSecretCredentialReferenceId": "string",
"updatedAt": "string",
"webhookUrl": "string"
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Get Trigger
Authorization
bearerAuth cookieAuth Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
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
Tenant identifier
Project identifier
Agent identifier
Resource identifier
^[a-zA-Z0-9\-_.]+$1 <= length <= 255Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://api.pilot.inkeep.com/manage/tenants/tenant_123/projects/project_456/agents/agent_789/triggers/resource_789"{
"data": {
"authentication": "string",
"createdAt": "string",
"description": "string",
"enabled": true,
"id": "string",
"inputSchema": "string",
"messageTemplate": "string",
"name": "string",
"outputTransform": "string",
"signatureVerification": {
"algorithm": "sha256",
"componentJoin": {
"separator": "string",
"strategy": "concatenate"
},
"encoding": "hex",
"signature": {
"key": "string",
"prefix": "string",
"regex": "string",
"source": "header"
},
"signedComponents": [
{
"key": "string",
"regex": "string",
"required": true,
"source": "header",
"value": "string"
}
],
"validation": {
"allowEmptyBody": true,
"headerCaseSensitive": false,
"normalizeUnicode": false
}
},
"signingSecretCredentialReferenceId": "string",
"updatedAt": "string",
"webhookUrl": "string"
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Update Trigger
Authorization
bearerAuth cookieAuth Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
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
Tenant identifier
Project identifier
Agent identifier
Resource identifier
^[a-zA-Z0-9\-_.]+$1 <= length <= 255Request Body
application/json
length <= 256Trigger description
Whether the trigger is enabled
Resource identifier
^[a-zA-Z0-9\-_.]+$1 <= length <= 255JSON Schema for input validation
Message template with {{placeholder}} syntax
1 <= lengthTrigger name
1 <= lengthlength <= 256Configuration for webhook signature verification
Reference to credential containing signing secret
length <= 256Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X PATCH "https://api.pilot.inkeep.com/manage/tenants/tenant_123/projects/project_456/agents/agent_789/triggers/resource_789" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"authentication": "string",
"createdAt": "string",
"description": "string",
"enabled": true,
"id": "string",
"inputSchema": "string",
"messageTemplate": "string",
"name": "string",
"outputTransform": "string",
"signatureVerification": {
"algorithm": "sha256",
"componentJoin": {
"separator": "string",
"strategy": "concatenate"
},
"encoding": "hex",
"signature": {
"key": "string",
"prefix": "string",
"regex": "string",
"source": "header"
},
"signedComponents": [
{
"key": "string",
"regex": "string",
"required": true,
"source": "header",
"value": "string"
}
],
"validation": {
"allowEmptyBody": true,
"headerCaseSensitive": false,
"normalizeUnicode": false
}
},
"signingSecretCredentialReferenceId": "string",
"updatedAt": "string",
"webhookUrl": "string"
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Delete Trigger
Authorization
bearerAuth cookieAuth Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
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
Tenant identifier
Project identifier
Agent identifier
Resource identifier
^[a-zA-Z0-9\-_.]+$1 <= length <= 255Response Body
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X DELETE "https://api.pilot.inkeep.com/manage/tenants/tenant_123/projects/project_456/agents/agent_789/triggers/resource_789"{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}List Trigger Invocations
Authorization
bearerAuth cookieAuth Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
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
Tenant identifier
Project identifier
Agent identifier
Resource identifier
^[a-zA-Z0-9\-_.]+$1 <= length <= 255Query Parameters
11 <= value101 <= value <= 100Filter by invocation status
"pending" | "success" | "failed"Start date for filtering (ISO8601)
date-timeEnd date for filtering (ISO8601)
date-timeResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://api.pilot.inkeep.com/manage/tenants/tenant_123/projects/project_456/agents/agent_789/triggers/resource_789/invocations"{
"data": [
{
"conversationId": "string",
"createdAt": "string",
"errorMessage": "string",
"id": "string",
"requestPayload": "string",
"status": "string",
"transformedPayload": "string",
"triggerId": "string"
}
],
"pagination": {
"limit": 10,
"page": 1,
"pages": 0,
"total": 0
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Get Trigger Invocation
Authorization
bearerAuth cookieAuth Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
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
Tenant identifier
Project identifier
Agent identifier
Resource identifier
^[a-zA-Z0-9\-_.]+$1 <= length <= 255Trigger Invocation ID
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://api.pilot.inkeep.com/manage/tenants/tenant_123/projects/project_456/agents/agent_789/triggers/resource_789/invocations/string"{
"data": {
"conversationId": "string",
"createdAt": "string",
"errorMessage": "string",
"id": "string",
"requestPayload": "string",
"status": "string",
"transformedPayload": "string",
"triggerId": "string"
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}