Report a message event

POST/v1/members/me/messages/{id}/events

Records what the guest did with a full-screen message. Send impression as soon as it's on screen, button_tap when a button is tapped, and close when it's dismissed any other way. Each type is recorded once per message, so retries are safe. An impression also stops the fallback push for this message.

Permissions: Member token.

Guide

Push and in-app messages

Request headers#

Idempotency-Keystring
Any string up to 255 characters; use a UUID v4. Kept 24 hours per key (or member) and endpoint. Same key and body replays the first response with Idempotent-Replayed: true.
Max Length 255

Path parameters#

idstring (uuid)Required
The message id.

Request body#

typestringRequired
impression, button_tap or close.
One of impression, button_tap, close
buttonstring
primary or secondary. Required for button_tap.
One of primary, secondary

Response fields#

Returns 204 with no body.

POST/v1/members/me/messages/{id}/events

1
2
3
4curl -X POST https://api.unplugdining.com/v1/members/me/messages/5b81d3e0-2c4f-4a96-8e17-d0f9a3b62c58/events \
  -H "Authorization: Bearer mt_4kQ9xV2mR7tB8nW3pL6yZ1cH5fJ0dS" \
  -H "Content-Type: application/json" \
  -d '{ "type": "button_tap", "button": "primary" }'

1
2
3
4
5
6
7
8
9const response = await fetch("https://api.unplugdining.com/v1/members/me/messages/5b81d3e0-2c4f-4a96-8e17-d0f9a3b62c58/events", {
  method: "POST",
  headers: {
    Authorization: "Bearer mt_4kQ9xV2mR7tB8nW3pL6yZ1cH5fJ0dS",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ type: "button_tap", button: "primary" }),
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10import requests

response = requests.post(
    "https://api.unplugdining.com/v1/members/me/messages/5b81d3e0-2c4f-4a96-8e17-d0f9a3b62c58/events",
    headers={
        "Authorization": "Bearer mt_4kQ9xV2mR7tB8nW3pL6yZ1cH5fJ0dS",
    },
    json={"type": "button_tap", "button": "primary"},
)
data = response.json()

Response JSON204

1(no body)

Error descriptions#

400Bad request

invalid_param

Unknown type or button.

400Bad request

missing_param

: button is missing on a button_tap.

404Not found

not_found

No such message for this member.

Any endpoint can also return the common errors.

400 Bad request

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#invalid_param",
  "title": "Bad request",
  "status": 400,
  "code": "invalid_param",
  "detail": "Unknown type or button."
}