Action to Trigger an Event
-
URL
REST API URL can be found on Apps Page
Sample Url for eg:
http://localhost:3000/api/apps/public/783d8e4d-b06a-409a-aaf3-b37650dc0a26/incoming
-
Method:
POST
-
Input Data Format
JSON
-
Data Params
Required:
-
action
=trigger-event
-
sessionId=[string]
Note. Session Id is the same session of Dialogflow. Also note that, session Id is the same as Room Id on Rocket.Chat. Click here to know more about Dialogflow sessions.
-
actionData: { event: { "name": string, "parameters": { object }, languageCode: string } }
The structure for this actionData is similar to EventInput
-
-
Sample Payload:
{ action: "trigger-event", sessionId: "uGM3uDZkAjtiBb4MA", actionData: { event: { name: "Welcome", parameters: { "name": "Sam" }, languageCode: "en" } } }
-
Success Response:
- Code: 200
Content:{ result: "Your request was processed successfully" }
- Code: 200
-
Error Response:
- Code: 400 BAD REQUEST
Content:
{ error: "Error: Session Id not present in request" }
OR
- Code: 500 Internal Server Error
Content:
{ error : "Error occurred while processing perform-handover. Details:- [Error Details]" }
- Code: 400 BAD REQUEST
-
Sample Call:
Curl
curl "http://localhost:3000/api/apps/public/21b7d3ba-031b-41d9-8ff2-fbbfa081ae90/incoming" \ -X POST \ -d "{\n \"action\": \"trigger-event\",\n \"sessionId\": \"uGM3uDZkAjtiBb4MA\",\n \"actionData\": {\n \"event\": {\n \"name\": \"Welcome\",\n \"parameters\": {\n \"name\": \"Sam\"\n },\n \"languageCode\": \"en\"\n }\n }\n}" \ -H "Content-Type: application/json"
HTTP
POST /api/apps/public/21b7d3ba-031b-41d9-8ff2-fbbfa081ae90/incoming HTTP/1.1 Host: localhost:3000 Content-Type: application/json { "action": "trigger-event", "sessionId": "uGM3uDZkAjtiBb4MA", "actionData": { "event": { "name": "Welcome", "parameters": { "name": "Sam" }, "languageCode": "en" } } }