Actions57
- Agents Actions
- Public Answer Actions
- Answer Management Actions
- Communications Actions
- Customers Actions
- Conversations Actions
- Get Conversations
- Get Conversation
- Patch Conversation
- Create Item
- Get Item
- Delete Item
- Get Media
- Get Voice Transcript
- Create Customer Item
- Delete Customer Item
- Get Conversation Items
- Add Topic To Conversation
- Delete Topic From Conversation
- Add Note To Conversation
- Get Note From Conversation
- Reply To Message
- Redact Content
- Export Actions
- Freeform Topics Actions
- Message Automation Actions
- Proactive Conversations Actions
- Tasks Actions
- User Identity Actions
- Topics Actions
- Webhooks Actions
- Payloads Actions
Overview
This node operation, Close Automation Session, is designed to close an active message automation session within a messaging or customer support platform. It allows users to explicitly end an ongoing automation session by providing the session's unique identifier and a description explaining why the session was closed.
Typical use cases include:
- Ending automated chat sessions after issue resolution.
- Closing sessions that are no longer needed to free up system resources.
- Logging reasons for session closure for auditing or analytics purposes.
For example, a customer support workflow might automatically close a chat automation session once the customer's issue is resolved, including a note such as "Issue resolved, closing session."
Properties
| Name | Meaning |
|---|---|
| Session Id | The unique identifier of the automation session to be closed. |
| Description | A brief, mandatory explanation for why the session is being closed. Cannot be left blank. |
Output
The node outputs JSON data representing the result of the close session request. This typically includes confirmation details such as the session ID, status of the closure, and any messages returned by the API indicating success or failure.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the external service managing message automation sessions.
- The node sends HTTP requests to the configured API endpoint (default base URL shown as a placeholder).
- Proper network connectivity and valid credentials are necessary for successful execution.
Troubleshooting
- Missing or invalid Session Id: Ensure the session ID provided corresponds to an active session. Invalid IDs will cause errors.
- Empty Description: The description field cannot be blank; provide a meaningful reason for closing the session.
- Authentication errors: Verify that the API key or authentication token is correctly configured and has sufficient permissions.
- Network issues: Check internet connectivity and API endpoint availability.
- API rate limits or server errors: If the API returns errors related to rate limiting or internal server problems, retry after some time or contact support.
Links and References
- Refer to the external API documentation of the message automation platform for detailed information on session management and closure endpoints.
- n8n documentation on creating and using custom nodes with API integrations.