Send notification

Sends a previously created push notification to all registered devices. The delivery occurs asynchronously after a successful API response. If the notification was created with a subrestaurant filter, it will only be sent to users of that location.

POST /push_notifications/send

Send notification

cURL

curl --request POST \
  --url https://app.xmenu.it/api/push_notifications/send \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "uid": "<string>"
}
'

200

Example

{
  "success": true,
  "error": "<string>",
  "message": "<string>"
}

write:push_notifications

Authorizations

clientId & clientSecretoauth2

X-Client-Id · string · header · required

Client ID for API Client authentication (must be used together with Client Secret)

X-Client-Secret · string · header · required

Client Secret for API Client authentication (must be used together with Client ID)

Body

application/json

uid · string · required

Unique identifier of the notification to send (obtained from the creation endpoint)

Response

200

application/json

Operation response

success · boolean · required

Operation result: true if successful, false if failed. Device delivery occurs asynchronously after a successful response.

error · string

Error code if the operation failed. Possible values:

• NOTIFICATION_NOT_FOUND = Notification not found or expired

See Error codes for general error codes that may also occur.

message · string

Human-readable error description if the operation failed