v1 (1.0.0)

Download OpenAPI specification:

v1

Webhook event 'keyword-notification' Webhook

Keyword notification webhook. This webhook is triggered when a keyword is detected in a conversation. The payload contains the conversation object.

Request Body schema: application/json
required

event	string The string 'keyword-notification'
	object (KeywordNotification)

Responses

Request samples

Payload

Content type

application/json

{"event": "keyword-notification",
"payload": {"id": 123,
"model_id": 123,
"model_name": "Acme Web Chat",
"created_at": "2025-05-05T05:05:05+0700",
"keyword": "urgent",
"most_recent_message": {"id": 123,
"seq": "01F8Z5J4G9F2X3Y4Z5G6H7J8K9",
"sender": "user",
"message": "Hello, how can I help you?",
"created_at": "2025-05-05T05:05:05+0700"
},
"recent_messages": [{"id": 123,
"seq": "01F8Z5J4G9F2X3Y4Z5G6H7J8K9",
"sender": "user",
"message": "Hello, how can I help you?",
"created_at": "2025-05-05T05:05:05+0700"
}
],
"platform": "web",
"platform_user_id": "u1234"
}
}

Get all models

Authorizations:

apiToken

query Parameters

page	integer <int32> Example: page=1 Page number to retrieve
per_page	integer <int32> Example: per_page=10 Number of rows per page
since	string <date-time> Example: since=2025-05-05T05:05:05+0700 Get only entries that have been created on or after this timestamp
until	string <date-time> Example: until=2025-05-05T05:05:05+0700 Get only entries that have been created on or before this timestamp

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 123,
"name": "Acme Web Chat",
"created_at": "2025-05-05T05:05:05+0700"
}
],
"page": 1,
"rows_per_page": 10,
"total_pages": 3,
"total_rows": 30
}

Get model by ID

Authorizations:

apiToken

path Parameters

model_id

required

integer <int64>

Example: 123

ID of the model

Responses

Response samples

200

Content type

application/json

{"id": 123,
"name": "Acme Web Chat",
"created_at": "2025-05-05T05:05:05+0700"
}

Get all conversations for a model

Authorizations:

apiToken

path Parameters

model_id

required

integer <int64>

Example: 123

ID of the model

query Parameters

page	integer <int32> Example: page=1 Page number to retrieve
per_page	integer <int32> Example: per_page=10 Number of rows per page
since	string <date-time> Example: since=2025-05-05T05:05:05+0700 Get only entries that have been created on or after this timestamp
until	string <date-time> Example: until=2025-05-05T05:05:05+0700 Get only entries that have been created on or before this timestamp
sort	string Default: "created_at" Enum: "created_at" "updated_at" Specifies the time field to use for filtering with `since` and `until`. Valid values are `created_at` or `updated_at`.

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 123,
"model_id": 123,
"model_name": "Acme Web Chat",
"created_at": "2025-05-05T05:05:05+0700",
"updated_at": "2025-05-05T05:05:05+0700",
"most_recent_message": {"id": 123,
"seq": "01F8Z5J4G9F2X3Y4Z5G6H7J8K9",
"sender": "user",
"message": "Hello, how can I help you?",
"created_at": "2025-05-05T05:05:05+0700"
},
"recent_messages": [{"id": 123,
"seq": "01F8Z5J4G9F2X3Y4Z5G6H7J8K9",
"sender": "user",
"message": "Hello, how can I help you?",
"created_at": "2025-05-05T05:05:05+0700"
}
],
"platform": "web",
"platform_user_id": "u1234"
}
],
"page": 1,
"rows_per_page": 10,
"total_pages": 3,
"total_rows": 30
}

Get all conversations

Authorizations:

apiToken

query Parameters

page	integer <int32> Example: page=1 Page number to retrieve
per_page	integer <int32> Example: per_page=10 Number of rows per page
since	string <date-time> Example: since=2025-05-05T05:05:05+0700 Get only entries that have been created on or after this timestamp
until	string <date-time> Example: until=2025-05-05T05:05:05+0700 Get only entries that have been created on or before this timestamp
sort	string Default: "created_at" Enum: "created_at" "updated_at" Specifies the time field to use for filtering with `since` and `until`. Valid values are `created_at` or `updated_at`.

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 123,
"model_id": 123,
"model_name": "Acme Web Chat",
"created_at": "2025-05-05T05:05:05+0700",
"updated_at": "2025-05-05T05:05:05+0700",
"most_recent_message": {"id": 123,
"seq": "01F8Z5J4G9F2X3Y4Z5G6H7J8K9",
"sender": "user",
"message": "Hello, how can I help you?",
"created_at": "2025-05-05T05:05:05+0700"
},
"recent_messages": [{"id": 123,
"seq": "01F8Z5J4G9F2X3Y4Z5G6H7J8K9",
"sender": "user",
"message": "Hello, how can I help you?",
"created_at": "2025-05-05T05:05:05+0700"
}
],
"platform": "web",
"platform_user_id": "u1234"
}
],
"page": 1,
"rows_per_page": 10,
"total_pages": 3,
"total_rows": 30
}

Get conversation by ID

Authorizations:

apiToken

path Parameters

conversation_id

required

integer <int64>

Example: 123

ID of the conversation

Responses

Response samples

200

Content type

application/json

{"id": 123,
"model_id": 123,
"model_name": "Acme Web Chat",
"created_at": "2025-05-05T05:05:05+0700",
"updated_at": "2025-05-05T05:05:05+0700",
"most_recent_message": {"id": 123,
"seq": "01F8Z5J4G9F2X3Y4Z5G6H7J8K9",
"sender": "user",
"message": "Hello, how can I help you?",
"created_at": "2025-05-05T05:05:05+0700"
},
"recent_messages": [{"id": 123,
"seq": "01F8Z5J4G9F2X3Y4Z5G6H7J8K9",
"sender": "user",
"message": "Hello, how can I help you?",
"created_at": "2025-05-05T05:05:05+0700"
}
],
"platform": "web",
"platform_user_id": "u1234"
}

Get all messages in a conversation

Authorizations:

apiToken

path Parameters

conversation_id

required

integer <int64>

Example: 123

ID of the conversation

query Parameters

page	integer <int32> Example: page=1 Page number to retrieve
per_page	integer <int32> Example: per_page=10 Number of rows per page

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 123,
"seq": "01F8Z5J4G9F2X3Y4Z5G6H7J8K9",
"sender": "user",
"message": "Hello, how can I help you?",
"created_at": "2025-05-05T05:05:05+0700"
}
],
"page": 1,
"rows_per_page": 10,
"total_pages": 3,
"total_rows": 30
}

v1 (1.0.0)

Webhook event 'keyword-notification' Webhook

Request Body schema: application/jsonrequired

Responses

Request samples

Get all models

Authorizations:

query Parameters

Responses

Response samples

Get model by ID

Authorizations:

path Parameters

Responses

Response samples

Get all conversations for a model

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get all conversations

Authorizations:

query Parameters

Responses

Response samples

Get conversation by ID

Authorizations:

path Parameters

Responses

Response samples

Get all messages in a conversation

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Request Body schema: application/json
required