Send a notification to currently open instances of a Zendesk app. Use when you need to push real-time notifications or data to a Zendesk app that is currently open in an agent's interface. The notification triggers an event in the app, which can then respond with custom behavior…
bodyThe message body or data to send to the app. Can be a string, number, boolean, object, array, or null. Maximum payload size is 1MB.
eventRequiredstringThe name of the event that will fire in the app. This is a custom event string that the app listens for to trigger its own logic.
app_idRequiredintegerThe ID of the app to send the notification to. Set to 0 for unpublished apps in development mode.
agent_idintegerThe ID of a specific agent to notify. If not provided, the notification will be sent to all currently open instances of the app.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.