Send notification to customer

Sends a push notification to a customer’s registered devices. The customer must be registered in the xMenu app and have at least one active device.

POST /push/send

Send notification to customer

cURL

curl --request POST \
  --url https://app.xmenu.it/api/push/send \
  --header 'X-Api-Key: <api-key>'

200

Example

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

Authorizations

apiKeyclientId & clientSecretoauth2

X-Api-Key · string · header · required

Restaurant API Key. Can be obtained from Tools > API Access in the xMenu dashboard.

Query Parameters

restuid · string · required

Restaurant unique identifier

customer_email · string<email> · required

Recipient's email address (must be a registered app user)

title · string · required

Push notification title

message · string · required

Push notification body text

Response

200

application/json

Operation response

success · boolean · required

Indicates successful delivery to associated devices

error · string

Error code if the operation failed. Possible values:

• CUSTOMER_NOT_FOUND = Customer not registered in the app
• DEVICE_NOT_FOUND = Customer has no active devices

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

message · string

Human-readable error description if the operation failed