Get a webhook endpoint

GET/v1/webhook_endpoints/{id}

Returns one endpoint, without its secret.

Permissions: Secret key with webhooks:manage.

Guide

Webhooks

Path parameters#

idstring (uuid)Required

Response fields#

Returns 200 with WebhookEndpoint

idstring (uuid)
The endpoint's id.
urlstring (uri)
Where events are sent. HTTPS on a public hostname.
descriptionstringNullable
Your label, up to 255 characters.
Max Length 255
event_typesarray of string
Types this endpoint gets, or ["*"] for all types, including types added later. See Webhook event types.
statusstring
enabled or disabled. unPLUG sets disabled after 3 days of failed deliveries.
One of enabled, disabled
secretstring
The signing secret, whsec_ followed by base64. Returned only when you create the endpoint or rotate the secret.
created_atstring (date-time)
When the endpoint was created.
updated_atstring (date-time)
When the endpoint last changed.

GET/v1/webhook_endpoints/{id}

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

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

Response JSON200

1
2
3
4
5
6
7
8
9{
  "id": "1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72",
  "url": "https://api.example.com/webhooks/unplug",
  "description": "Loyalty sync",
  "event_types": ["points.changed", "tier.changed", "reward.issued", "member.deleted"],
  "status": "enabled",
  "created_at": "2026-11-02T14:51:30Z",
  "updated_at": "2026-11-02T14:51:30Z"
}

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