Skip to main content
MoEngage
Previewv1.0.0
40 actions · 1 auth method
MarketingUsersEventsTrackingCampaignsCatalogsProductsContentEmailSegmentsAudienceTemplatesSubscriptions

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · Basic Auth (Workspace ID + API Key)

You need a MoEngage workspace with admin access to the API Key Dashboard. Generate a multi-permission API key with acces…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · Basic Auth (Workspace ID + API Key)

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

40 actions
Action
Description
Track User
Track user
Merge User
Merge user
Delete User (S2S)
Delete user (S2S)
Export User (S2S)
Export user (S2S)
Create Event
Create event
Bulk / Batch Import Users + Events
Bulk import
Create Business Event
Create business event
Trigger Business Event
Trigger business event
Create / Send Campaign (asap, Scheduled, Weekly, Event-triggered, Business-event, Geofence, Device, Push-personalised)
Create or send any MoEngage campaign — push, email, SMS, in-app, web-push — at any delivery mode
Search Campaigns
Search campaigns
Update Campaign
Update a campaign
Get Campaign Meta
Get paginated campaign metadata. Filter by id, channel, status, name, tags or date ranges via campaign_fields.
Create Catalog
Create a new catalog in MoEngage
Add Catalog Attributes
Add new attribute definitions to an existing catalog’s schema.
Ingest Catalog Items
Bulk-ingest items into a catalog.
Update Catalog Items
Update attributes of existing catalog items.
Delete Catalog Items (bulk)
Delete items from a catalog in bulk.
Search Catalog Items
Fetch catalog items by id.
Create Content Block
Create a new content block in MoEngage
Update Content Block
Update an existing content block in MoEngage
Search / List Content Blocks
Search content blocks in the workspace; returns content block IDs needed for update_content_block.
Get Specific Content Blocks By ID
Fetch one or more content blocks by their IDs, including raw content.
Create File / CSV-Upload Segment
Create a file-based custom segment from a public CSV URL
Create Filter Segment
Create a filter/rule-based custom segment
Update / Modify Filter Segment (Mutates)
Update an existing filter-based custom segment
Get Custom Segment By ID
Retrieve a custom segment by its ID
Add Users To File Segment (CSV)
Add users from a CSV file to an existing file/CSV-uploaded segment.
Remove Users From File Segment (CSV)
Remove users (listed in a CSV) from an existing file/CSV-uploaded segment.
List Custom Segments
List all custom segments in the workspace
Create Custom Push Template
Create a new custom push notification template in MoEngage.
Update Custom Push Template
Update an existing custom push notification template in MoEngage.
Create Custom SMS Template
Create a new custom SMS template in MoEngage.
Update Custom SMS Template
Update an existing custom SMS template in MoEngage.
Create Custom In-App Template
Create a new custom in-app template in MoEngage.
Update Custom In-App Template
Update an existing custom in-app template in MoEngage.
Create Email Template
Create a new email template via the V2 email templates API in MoEngage.
Get All Email Templates
Retrieve all email templates in the MoEngage workspace.
Get Specific Email Template
Retrieve a single email template by its ID.
Get User Subscription Preferences (READ)
Get user subscription preferences
Update User Subscription Preferences (per-category, MUTATES)
Update user subscription preferences