Actions113
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Webhooks Actions
- Teams Actions
- Custom Filters Actions
- Reports Actions
Overview
This node interacts with the Inbox API to retrieve detailed information about a specific inbox. It is useful when you need to fetch metadata or configuration details of an inbox channel identified by a unique identifier. Typical use cases include monitoring inbox settings, auditing inbox configurations, or integrating inbox details into workflows for customer support or communication management.
Properties
| Name | Meaning |
|---|---|
| Inbox Identifier | The unique identifier of the inbox channel obtained from the API. This is required to specify which inbox's details to retrieve. |
Output
The node outputs JSON data containing the detailed information of the specified inbox. This typically includes all relevant properties and metadata associated with that inbox as returned by the Inbox API. There is no binary data output.
Dependencies
- Requires an API key credential for authenticating requests to the Inbox API.
- The base URL for the API must be configured in the node credentials.
- The node depends on the external Inbox API service being available and accessible.
Troubleshooting
- Common issues:
- Invalid or missing Inbox Identifier will cause the request to fail.
- Incorrect or expired API authentication token may result in authorization errors.
- Network connectivity problems can prevent successful API calls.
- Error messages:
- "Inbox Identifier is required" — Ensure the property is set before execution.
- "Unauthorized" or "Authentication failed" — Verify the API key or authentication token.
- "Not Found" — Confirm the inbox identifier exists and is correct.
- To resolve these, double-check input values, credentials, and network access.
Links and References
- Refer to the official Inbox API documentation for details on the inbox resource and its fields.
- Consult your API provider’s authentication guide to properly configure credentials.