Get an event

GET/v1/events/{id}

Returns one event. Use it to check a webhook you received against what unPLUG sent.

Permissions: Secret key with webhooks:manage.

Guide

Webhooks

Path parameters#

idstring (uuid)Required

Response fields#

Returns 200 with Event

idstring (uuid)
The event's id. Same value as the webhook-id header, on every attempt and redelivery.
typestring
For example points.changed. The list may grow.
Show valuesHide values
- member.created
- member.updated
- member.deleted
- points.changed
- tier.changed
- reward.issued
- reward.redeemed
- reward.expiring
- order.credited
- order.refunded
- communication_preferences.updated
- webhook.test
- points.expiring
- challenge.joined
- challenge.progressed
- challenge.completed
- referral.completed
created_atstring (date-time)
When the change happened. Use it to order events.
api_versionstring
v1.
livemodeboolean
true in production, false in the sandbox.
brand_idstring (uuid)
Your brand.
dataobject
Show attributesHide attributes
- objectobject
  Snapshot of the resource.
- previous_attributesobject

GET/v1/events/{id}

1
2curl https://api.unplugdining.com/v1/events/7f3a9c2e-4b8d-4e16-a0c5-1d6b8e2f9a47 \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6const response = await fetch("https://api.unplugdining.com/v1/events/7f3a9c2e-4b8d-4e16-a0c5-1d6b8e2f9a47", {
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
  },
});
const data = await response.json();

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

response = requests.get(
    "https://api.unplugdining.com/v1/events/7f3a9c2e-4b8d-4e16-a0c5-1d6b8e2f9a47",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23{
  "id": "7f3a9c2e-4b8d-4e16-a0c5-1d6b8e2f9a47",
  "type": "points.changed",
  "created_at": "2026-11-05T14:08:52Z",
  "api_version": "v1",
  "livemode": true,
  "brand_id": "e5a1c7d9-2f4b-4c8e-a3d6-8b0f1e9c2a57",
  "data": {
    "object": {
      "id": "b3e7c1f9-8a2d-4b6e-9c05-2f4a7d1e8b36",
      "member_id": "3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40",
      "type": "earn",
      "points": 90,
      "balance_after": 510,
      "description": "Order app-30417",
      "order_id": "c9e5a3f1-7d2b-4e8c-a0f6-3b1d9e5c7a24",
      "reward_id": null,
      "adjustment_reason": null,
      "created_at": "2026-11-05T14:08:52Z"
    },
    "previous_attributes": {}
  }
}

Error descriptions#

404Not found

not_found

No such event, or it's older than 30 days.

Any endpoint can also return the common errors.

404 Not found

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "No such event, or it's older than 30 days."
}