Send a test webhook

POST/v1/test/webhooks

Sends one event of any type, with sample data, to every enabled endpoint subscribed to that type. Use it to build and test your handler for events that are hard to cause, such as tier.changed or member.deleted. Deliveries are signed like real ones.

Permissions: Sandbox secret key.

Guide

Sandbox

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

Request body#

typestringRequired
Any event type from Webhook event types.
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

id is the event id. It arrives at your endpoints as webhook-id, and you can look up its deliveries in the event log. The sample data is not a real member, so don't let your handler write it to production tables.

Response fields#

Returns 202 with object

idstring (uuid)
typestring

POST/v1/test/webhooks

1
2
3
4curl -X POST $UNPLUG_API/test/webhooks \
  -H "Authorization: Bearer $UNPLUG_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "type": "tier.changed" }'

1
2
3
4
5
6
7
8
9const response = await fetch(`${process.env.UNPLUG_API}/test/webhooks`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ type: "tier.changed" }),
});
const data = await response.json();

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

response = requests.post(
    f"{os.environ['UNPLUG_API']}/test/webhooks",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
    json={"type": "tier.changed"},
)
data = response.json()

Response JSON202

1
2
3
4{
  "id": "9b4e2c7a-1f6d-4a83-8e0b-5d3c7f1a9e26",
  "type": "tier.changed"
}

Error descriptions#

400Bad request

invalid_param

type isn't a known event type.

404Not found

not_found

Called on production.

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": "type isn't a known event type."
}