Send a test event

POST/v1/webhook_endpoints/{id}/test

Sends a webhook.test event to this endpoint only, signed like any other event. Works on disabled endpoints too, so you can check a fix before you turn the endpoint back on. The response is the event; follow its delivery with List deliveries.

Permissions: Secret key with webhooks:manage.

Guide

Webhooks

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

Response fields#

Returns 202 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

POST/v1/webhook_endpoints/{id}/test

1
2curl -X POST https://api.unplugdining.com/v1/webhook_endpoints/1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72/test \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6
7const response = await fetch("https://api.unplugdining.com/v1/webhook_endpoints/1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72/test", {
  method: "POST",
  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.post(
    "https://api.unplugdining.com/v1/webhook_endpoints/1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72/test",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON202

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15{
  "id": "d4c7a2e9-1f6b-4e85-8c3a-9b5d0e7f2a16",
  "type": "webhook.test",
  "created_at": "2026-11-06T09:15:40Z",
  "api_version": "v1",
  "livemode": true,
  "brand_id": "e5a1c7d9-2f4b-4c8e-a3d6-8b0f1e9c2a57",
  "data": {
    "object": {
      "webhook_endpoint_id": "1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72",
      "message": "Test event from unPLUG."
    },
    "previous_attributes": {}
  }
}

Error descriptions#

404Not found

not_found

No endpoint with this id in this environment.

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 endpoint with this id in this environment."
}