Skip to main content

POST /events/notifications

Use this method to or generate a test event that pushes to a specific push notification service or subscription.

Authentication

Authentication with username and password is required.

Request URL

POST https://{management_server_IP}/events/notifications

Query parameters

ParametersRequired / OptionalDescription
includeAttributes=testRequiredGenerate a test event that gets pushed to a specific push notification service or subscription
The following example generates a test event that gets pushed to the specified target.
POST https://192.0.2.0/events/notifications?includeAttributes=test

Request body

AttributesRequired / OptionalTypeDefinition
targetIDRequiredStringIf targetType is pusher, this is the type of push notification service. This can be one of the following values.
  • AndroidPusher. Google device push service
  • iOSPusher. Apple device push service
  • WebSocketPusher. WebSocket servic

If targetType is subscriber, this is the subscription UID. To obtain the subscription UID, use the GET /events/notifications/subscriptions method.

targetTypeOptionalIntegerTarget of the test action. This can be one of the following values.
  • pusher. Push notification service

  • subscriber. Subscription

This example retrieves information about the Android the push notification service:
{
"targetType":"pusher",
"targetID":"AndroidPusher"
}
This example retrieves information for a subscription with UID 1.
{
"targetType":"subscriber",
"targetID":"1"
}

Response codes

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body

None