Push | Novu Documentation

The push step allows you to send notifications to mobile and web applications through various push notification providers.

Example Usage

await step.push('new-message', async () => {
  return {
    title: 'New Message',
    body: 'You have received a new message from John',
    data: {
      messageId: '123',
      senderId: '456',
    },
  };
});

Push Step Output

Property	Type	Required	Description
title	string	Yes	The notification title that appears in the push notification
body	string	Yes	The main content of the push notification
data	object	No	Additional data to be sent with the notification
image	string	No	URL of an image to display in the notification
icon	string	No	URL of an icon to display in the notification

Push Step Result

The push step does not return any result object.

Provider Configuration

To send push notifications, you need to configure the appropriate push provider credentials. See our Push Provider Documentation for detailed setup instructions.

Push Channel Step

Example Usage

Push Step Output

Push Step Result

Provider Configuration

On this page