Report a message event from your server

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

The same as Report a message event, for a server-to-server integration. Each type is recorded once per message, so retries are safe.

Permissions: Secret key with members:write.

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 member id.
message_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/{id}/messages/{message_id}/events

1
2
3
4curl -X POST https://api.unplugdining.com/v1/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/messages/5b81d3e0-2c4f-4a96-8e17-d0f9a3b62c58/events \
  -H "Authorization: Bearer $UNPLUG_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "type": "impression" }'

1
2
3
4
5
6
7
8
9const response = await fetch("https://api.unplugdining.com/v1/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/messages/5b81d3e0-2c4f-4a96-8e17-d0f9a3b62c58/events", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ type: "impression" }),
});
const data = await response.json();

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

response = requests.post(
    "https://api.unplugdining.com/v1/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/messages/5b81d3e0-2c4f-4a96-8e17-d0f9a3b62c58/events",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
    json={"type": "impression"},
)
data = response.json()

Response JSON204

1(no body)

Error descriptions#

400Bad request

invalid_param

Unknown type or button.

404Not found

not_found

No such member or message.

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."
}