Update a webhook endpoint

PATCH/v1/webhook_endpoints/{id}

Changes the URL, the event types, the description or the status. Send only the fields you change. Set status to enabled to turn an endpoint back on after unPLUG disabled it; deliveries start again with new events.

Permissions: Secret key with webhooks:manage.

Guide

Webhooks

Path parameters#

idstring (uuid)Required

Request body#

urlstring (uri)
New HTTPS URL. The secret stays the same.
event_typesarray of string
Replaces the whole list.
Min Items 1
descriptionstring
Your label.
Max Length 255
statusstring
enabled or disabled.
One of enabled, disabled

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.

PATCH/v1/webhook_endpoints/{id}

1
2
3
4
5
6
7curl -X PATCH https://api.unplugdining.com/v1/webhook_endpoints/1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72 \
  -H "Authorization: Bearer $UNPLUG_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "event_types": ["points.changed", "tier.changed", "reward.issued", "member.deleted", "communication_preferences.updated"],
    "status": "enabled"
  }'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18const response = await fetch("https://api.unplugdining.com/v1/webhook_endpoints/1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    event_types: [
      "points.changed",
      "tier.changed",
      "reward.issued",
      "member.deleted",
      "communication_preferences.updated",
    ],
    status: "enabled",
  }),
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20import os
import requests

response = requests.patch(
    "https://api.unplugdining.com/v1/webhook_endpoints/1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
    json={
        "event_types": [
            "points.changed",
            "tier.changed",
            "reward.issued",
            "member.deleted",
            "communication_preferences.updated",
        ],
        "status": "enabled",
    },
)
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", "communication_preferences.updated"],
  "status": "enabled",
  "created_at": "2026-11-02T14:51:30Z",
  "updated_at": "2026-11-06T09:14:02Z"
}

Error descriptions#

400Bad request

invalid_param

Bad URL, unknown event type or unknown status.

404Not found

not_found

No endpoint with this id in this environment.

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": "Bad URL, unknown event type or unknown status."
}