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 allows sending event payloads to an external API, specifically handling "Events" under the "Payloads" resource. It is designed to transmit structured event data such as agent availability updates, including details about the event's unique ID, type, timestamp, initiator, and content.
Common scenarios include:
- Tracking real-time status changes of agents in a customer support system.
- Logging events related to user or system actions for audit or monitoring purposes.
- Integrating with external systems that require event notifications formatted in a specific structure.
For example, you could use this node to notify another service whenever an agent's availability status changes, providing the exact time and context of the update.
Properties
| Name | Meaning |
|---|---|
| Id | Unique identifier for the event being sent. |
| Type | The category/type of the event. Options: AGENT AVAILABILITY UPDATED. |
| Timestamp | The ISO 8601 timestamp indicating when the event was recorded. |
| Initiator | The entity (type and ID) that triggered the event, e.g., an agent or system component. |
| Content | Detailed content of the event, such as agent ID, available channels (e.g., MAIL, VOICE), and the occurrence time. |
Output
The node outputs JSON data representing the response from the API after sending the event. This typically includes confirmation of the event receipt or any relevant metadata returned by the external service.
No binary data output is indicated in the source code.
Dependencies
- Requires an API key credential for authentication with the external API.
- The base URL for requests is set to
https://petstore3.swagger.io/api/v3(likely a placeholder). - Uses HTTP headers to accept and send JSON content (
Accept: application/json,Content-Type: application/json).
Troubleshooting
- Invalid or missing required properties: Ensure all required fields (
Id,Type,Timestamp,Initiator,Content) are provided and correctly formatted. - Authentication errors: Verify that the API key credential is configured properly in n8n.
- API endpoint issues: The base URL points to a Swagger Petstore demo; replace it with the actual API endpoint for production use.
- Incorrect event type: Only the option
AGENT AVAILABILITY UPDATEDis supported currently; using unsupported types may cause errors. - Timestamp format errors: The timestamp must be in valid ISO 8601 format.
Links and References
- ISO 8601 Date and Time Format
- Gladly API Documentation (assumed based on naming; replace with actual if known)
- n8n HTTP Request Node Documentation (for understanding how API calls are made)