Push Event

1.   / 
2. API   / 
3. Push Subscriptions   / 
4. Push Event

---

Description

wss push_event_create

The push_event_create request сreates a custom event to send.

Request Parameters

Name	Type	Description
recipients_ids	array[string]	Array of recipient IDs
message	object	Message object

Response Fields

Name	Type	Description
event.message	string	Message in string format
event.recipients_ids	string	Array of recipients IDs

Example

Request

{
  "request": {
    "push_event_create": {
      "recipients_ids": [
        "644157e316eec28e3dfb8b31",
        "644157e316eec28e3dfb8b32"
      ],
      "message": {
        "title": "Title",
        "body": "Message body"
      }
    },
    "id": "RequestId",
  }
}

Response

{
  "response": {
    "id": "RequestId",
    "event": {
      "_id": "64415891066758fe6754f477",
      "user_id": "64415890066758fe6754f472",
      "recipients_ids": [
        "644157e316eec28e3dfb8b31",
        "644157e316eec28e3dfb8b32"
      ],
      "message": "{\"title\":\"Title\",\"body\":\"Message body\"}",
      "created_at": "2025-08-13T05:51:44.733Z",
      "updated_at": "2025-08-13T05:51:44.733Z"
    }
  }
}