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 updates the status of a message in a Custom Channel within a communication platform. It is useful for tracking and managing message lifecycle events such as when a message is accepted, delivered, read, or failed. For example, after sending a message through a custom channel, you can update its status to "DELIVERED" once it reaches the recipient, or mark it as "FAILED" if there was an error.
Common scenarios include:
- Synchronizing message statuses between your system and the communication platform.
- Providing real-time feedback on message delivery to users.
- Logging message state changes for auditing or analytics.
Properties
| Name | Meaning |
|---|---|
| Custom Channel Id | The unique identifier of the Custom Channel where the message was sent. This ID can be found by opening the overflow menu of a Custom Channel Entry Point and selecting "View Integration Data". |
| Message Id | The unique identifier of the message whose status you want to update. |
| Value | The new status value for the message. Possible values are: ACCEPTED, DELIVERED, READ, FAILED. |
| Details | Optional additional information about the status update. Particularly useful when the status is FAILED to provide error details or context. |
Output
The node outputs JSON data representing the response from the API after updating the message status. This typically includes confirmation of the updated status and any relevant metadata returned by the service.
If the node supports binary data output, it would represent related media or attachments associated with the message status update, but based on the provided code and properties, this node primarily deals with JSON responses.
Dependencies
- Requires an API key credential for authenticating requests to the communication platform's API.
- The base URL for API requests is set to a placeholder (
https://petstore3.swagger.io/api/v3) in the bundled source, which should be replaced with the actual API endpoint. - The node depends on an OpenAPI specification to define its properties and request structure.
Troubleshooting
- Invalid Custom Channel Id or Message Id: Ensure that the IDs are correct and correspond to existing entities in the platform. Incorrect IDs will cause the API to reject the request.
- Unauthorized Errors: Verify that the API key or authentication token is valid and has sufficient permissions to update message statuses.
- Invalid Status Value: Only the specified status options (
ACCEPTED,DELIVERED,READ,FAILED) are accepted. Using other values will result in errors. - Missing Required Fields: Both
Custom Channel IdandMessage Idare mandatory. Omitting them will cause the node to fail. - Failed Status Without Details: When setting the status to
FAILED, providing meaningful details is recommended to aid troubleshooting.
Links and References
- Gladly API Documentation (replace with actual link)
- Custom Channel Integration Guide (replace with actual link)
- n8n Documentation on Creating Custom Nodes