Send an update about your chatbot user's activity to the chatbot, such as whether the most recent message from the chatbot has been read, or the chatbot user has started or stopped typing.
Request
The webhook integration page contains the base URL to use for all webhook endpoints and the access token to include as a Bearer token in all requests.
| Endpoint | POST | {baseURL}/conversations/{conversationId}/activity |
| Headers | Content-Type | application/json |
| Authorization | Bearer {AccessToken} | |
| Path parameters | conversationID | The chat identifier that was returned when you initiated the chat. |
| Body | {
"author" :{
"type": "user"
},
"type": "{activityType}"
} |
A JSON object containing:
Activity types are strings, not objects. |
curl --location 'https://au.api.ingenious.ai/messaging/webhook/v1/{teamId}/{botId}/conversations/{conversationId}/activity' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {accessToken}' \
--data '{
"author" :{
"type": "user"
},
"type": "typing:start"
}'Response
| Response code | Description |
|---|---|
| 200 |
Acknowledged. An empty JSON object is returned to acknowledge the request. Requests that result in issues still return the acknowledgement and empty object. |
| 400 | Error. Common causes of errors include a malformed or missing activity type, an incomplete webhook integration, incorrect or missing authorization headers, or invalid chatbot or team ID in the base URL. |