Skip to main content
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

PropertyTypeRequiredDescription
titlestringYesThe notification title that appears in the push notification
bodystringYesThe main content of the push notification
dataobjectNoAdditional data to be sent with the notification
imagestringNoURL of an image to display in the notification
iconstringNoURL 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.