Create a campaign and send it now

Create a push campaign — pick the audience, the template and the provider — and send it now.

Where: Push → Campaigns → Create Campaign · /projects/<project>/push/campaigns/new

You also land here from a template (Actions → Create Campaign in the editor) or from a campaign (Create new from this on its details page); then the template is already picked (…/campaigns/new?t=<template id>).

Before you start

• An enabled push integration. Right after you enable the module the Fake Push (Test Me) is there and is the default, so nothing real is sent until you pick another one.

• A push template with a title and a body.

• Someone to send to: users with at least one registered device. A user without a device is skipped, not counted as failed. The form counts the devices of the audience for you and keeps Send off while the audience reaches none.

Steps

1. Press Create Campaign. The form Add New Push Campaign opens with All users selected and the count This audience reaches 3 devices.

   

   The recipient cards.
2. Under Please choose how you would like to select your recipients. pick one card:

   Card	Who gets the push	Fields
   All users	Every project user with a registered device.	Select role(s) — optional; Send to devices on — All platforms or iOS, Android, Chrome, Safari (only the platforms your integrations can reach are offered).
   Collection	The users named in the records of a database collection. Greyed out while Database is off or there is no collection.	Collection, Recipient field(s), comma separated (e.g. userId), What the field holds: A user id.
   Specified Users	The users you pick. The picker lists only users with a device.	To: — e.g. [e-mail].
   Devices	The registered devices you pick, one by one.	Devices: — a picker with a token / user id filter and a platform filter.
   Account users	The account owner and team members you pick, through the devices they registered as project users.	Account users:, Send to devices on.

   

   The Devices card opens a picker of the registered devices.
3. Fill Template Details:

   Field	Required	What it does	Example
   Select template	yes	The template to send; the type is shown next to the name.	Order shipped (Transactional)
   Send in specific language	no	Each recipient's language (default): the recipient's language when it is a project language, else the project default. Or one project language for everyone.	Each recipient's language
   Template Tokens	yes, each	Every @Model.… token of the title and the body. Reserved tokens fill themselves; your own tokens need a value. Send turns on only when every token has one.	FirstName = Ada, OrderNumber = A-10482

   

   A send to one user with both tokens filled.
4. Check Advanced settings (Optional fields to customize your push delivery.):

   Field	Required	What it does	Example
   Send push on behalf of	no	The person whose details fill the @Model.Initiator.User.… tokens. Empty = you.	empty
   Select push provider	yes	The integration that delivers the campaign. The project default is picked for you.	Test Me (Fake)
   When to send	yes	Send now (default) or Send later — see Schedule a campaign.	Send now

   

   The whole form with the default provider picked.
5. Press Send. Cancel goes back to the list without creating anything.

Result

Cloud returns to the campaigns list. The new row appears within 15 seconds and moves Registered → Processing → Completed; its batches, statistics and messages are on the details page. Through the Fake integration the messages are recorded as sent and nothing reaches a device.

The campaign has completed.

Change or remove it later

• Edit — a campaign cannot be changed after it is created. Use Create new from this on its details page to start a new one with the same template.

• Stop — a campaign that is still waiting or sending can be stopped.

• Delete — once it is Completed, Stopped or Failed, from the Actions menu of its details page.

Do it from code

source names the audience (AllUsers, SpecifiedUsers, AccountUsers, Collection, Devices); the audience fields sit next to it in campaign.

const { id } = await norbix.hub.notifications.createPushCampaign({
  campaign: {
    source: 'SpecifiedUsers',
    templateId: 'tmpl_bp0fFX5IcoudBYiH6cwtJ', // Order shipped
    integrationId: 'int_5w5gi8BSgF9H7E76Ud6K7F', // Test Me (Fake)
    userRecipients: ['usr_5Us6T01VpYu3PgK6a1d4tv'], // Ada Lovelace
    mappedTokens: [
      { key: 'FirstName', value: 'Ada', resolver: 'Custom' },
      { key: 'OrderNumber', value: 'A-10483', resolver: 'Custom' },
    ],
  },
});
console.log(id); // cmp_7LX6kndj6fMBX3ZbsiATog

norbix hub notifications push campaign create --campaign '{"source":"Devices","templateId":"tmpl_5IStKcssvWDLtEJLJdFKvJ","integrationId":"int_5w5gi8BSgF9H7E76Ud6K7F","devices":[{"token":"fK3pZ8qLR0e1:APA91bH7xQ2vN5mT8wY1cE4rU6iO9pA3sD5fG7hJ9kL1zX3cV5bN7mQ9wE2rT4yU6iO8pA0sD2fG4hJ6kL8zX0cV2bN4mQ6w","deliveryFamily":"Android"}]}'

To count the devices an audience reaches before you send, call Get Push Campaign Audience Count with the same campaign (it answered { devices: 3, recipients: 3 } for All users here). The client setup is on the Push page. API: Create Push Campaign