> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.
# Test Trigger with External Service
>
Test your Livechat trigger setup with external service using this endpoint. Make sure that you have created the trigger. Permission required: `view-livechat-manager`. Rate limit applies: 15 requests per 60000 milliseconds.
## OpenAPI
````json POST /api/v1/livechat/triggers/external-service/test
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "Omnichannel"
},
"servers": [
{
"url": "https://apiexplorer.support.rocket.chat"
}
],
"tags": [
{
"name": "Omnichannel Users"
},
{
"name": "Omnichannel Agents"
},
{
"name": "Omnichannel Monitors"
},
{
"name": "Omnichannel Visitors"
},
{
"name": "Omnichannel Contacts"
},
{
"name": "Omnichannel Rooms"
},
{
"name": "Omnichannel Departments"
},
{
"name": "Omnichannel Custom Fields"
},
{
"name": "Omnichannel Business Hours"
},
{
"name": "Omnichannel Priorities"
},
{
"name": "Omnichannel Tags"
},
{
"name": "Omnichannel Units"
},
{
"name": "SLA Policies"
},
{
"name": "Canned Responses"
},
{
"name": "Omnichannel Transcript"
},
{
"name": "Omnichannel Statistics"
},
{
"name": "Omnichannel Agent Stats"
},
{
"name": "Omnichannel Dashboards"
},
{
"name": "Reports"
},
{
"name": "Omnichannel Inquiries"
},
{
"name": "Omnichannel Webhooks"
},
{
"name": "Livechat"
},
{
"name": "Livechat Appearance"
},
{
"name": "Livechat Triggers"
},
{
"name": "Livechat Messages"
},
{
"name": "Livechat Page Visited"
}
],
"paths": {
"/api/v1/livechat/triggers/external-service/test": {
"post": {
"summary": "Test Trigger with External Service",
"tags": [
"Livechat Triggers"
],
"responses": {
"200": {
"description": "OK\n\nRocket.Chat sends a request to the webhook containing a payload of the visitor metadata. The webhook returns the response as demonstrated in this example.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"triggerId": {
"type": "string"
},
"response": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"msg": {
"type": "string"
},
"order": {
"type": "integer"
}
}
}
}
}
},
"success": {
"type": "boolean"
}
}
},
"examples": {
"Example 1": {
"value": {
"triggerId": "test-trigger",
"response": {
"statusCode": "200",
"contents": [
{
"msg": "Welcome to our support center, Morgan! How can we assist you today?",
"order": "0"
},
{
"msg": "Feel free to ask any questions you have. We're here to help!",
"order": "1"
}
]
},
"success": "true"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": "string"
},
"errorType": {
"type": "string"
}
}
},
"examples": {
"Example 1": {
"value": {
"success": "false",
"error": "must have required property 'webhookUrl' [invalid-params]",
"errorType": "invalid-params"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/authorizationError"
}
},
"operationId": "post-api-v1-livechat-triggers-external-service-test",
"description": "\n\nTest your Livechat trigger setup with external service using this endpoint. Make sure that you have created the trigger. Permission required: `view-livechat-manager`. Rate limit applies: 15 requests per 60000 milliseconds.",
"parameters": [
{
"$ref": "#/components/parameters/AuthToken"
},
{
"$ref": "#/components/parameters/UserId"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"webhookUrl",
"timeout",
"fallbackMessage"
],
"properties": {
"webhookUrl": {
"type": "string",
"description": "Enter the external webhook URL.",
"example": "https://webhook.site/2f5df6a1-592c-4d9f-8f36-ab15ca3caf23"
},
"timeout": {
"type": "string",
"description": "Enter the time in milliseconds to wait for the external service to respond before cancelling the request.",
"example": "10000"
},
"fallbackMessage": {
"type": "string",
"description": "Enter the message to send after the timeout ends.",
"default": "Request timeout"
}
}
},
"examples": {
"Example 1": {
"value": {
"webhookUrl": "https://webhook.site/2f5df6a1-592c-4d9f-8f36-ab15ca3caf23",
"timeout": "10000",
"fallbackMessage": "Request timeout"
}
}
}
}
}
}
}
}
},
"components": {
"responses": {
"authorizationError": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"examples": {
"Authorization Error": {
"value": {
"status": "error",
"message": "You must be logged in to do this."
}
}
}
}
}
}
},
"parameters": {
"AuthToken": {
"name": "X-Auth-Token",
"in": "header",
"description": "The `authToken` of the authenticated user.",
"required": "true",
"schema": {
"type": "string"
},
"example": "RScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f"
},
"UserId": {
"name": "X-User-Id",
"in": "header",
"description": "The `userId` of the authenticated user.",
"required": "true",
"schema": {
"type": "string"
},
"example": "rbAXPnMktTFbNpwtJ"
}
}
}
}
````
![\"Enterprise\"](\"https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/Enterprise%20tag.svg\")