API docs by Redocly

Push Gateway API (1.0.0)

Download OpenAPI specification:

License: Apache 2.0

API for interacting with the Push Gateway

Push Gateway

Push plain data to the gateway

Submit a plain push notification to the Push Gateway. The notification will be sent to all devices listed in the devices array of the notification object.

This mimics the Matrix Push Gateway API in version 1.0.0.

Authorizations:
mtls
Request Body schema: application/json
required
required
object (PlainNotification)

Information about the push notification

Responses

Request samples

Content type
application/json
{
  • "notification": {
    }
}

Response samples

Content type
application/json
{
  • "rejected": [
    ]
}

Push multiple plain notifications to the gateway in a single request

Submit multiple plain push notifications in a single batch request. This endpoint is optimized for high-throughput scenarios where multiple plain notifications need to be sent efficiently. The batch can contain up to a maximum of 100 notifications per request.

Authorizations:
mtls
Request Body schema: application/json
required
required
Array of objects [ 1 .. 100 ] items unique

Array of plain notifications to process in this batch

Responses

Request samples

Content type
application/json
{
  • "notifications": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "results": [
    ],
  • "summary": {
    }
}

Push multiple encrypted notifications to the gateway in a single request

Submit multiple encrypted push notifications in a single batch request. This endpoint is optimized for high-throughput scenarios where multiple encrypted notifications need to be sent efficiently. The batch can contain up to a maximum of 100 notifications per request.

Authorizations:
mtls
Request Body schema: application/json
required
required
Array of objects [ 1 .. 100 ] items unique

Array of encrypted notifications to process in this batch

Responses

Request samples

Content type
application/json
{
  • "notifications": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "results": [
    ],
  • "summary": {
    }
}