Update webhook endpoint

Updates mutable fields of a webhook endpoint (url, events, description, status). Only fields included in the body are changed. Events, if provided, REPLACE the previous subscription set — no partial merge. Use status: "disabled" to pause deliveries without deleting the endpoint.

Authorization

bearer

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url?string

New destination URL. MUST use HTTPS. Omit to leave unchanged.

Formaturi

events?array<string>

Replacement list of subscribed event types. Replaces the previous set entirely. Omit to leave unchanged.

Items1 <= items

description?string

New human-readable description. Omit to leave unchanged.

status?string

New lifecycle status. Set to "disabled" to pause deliveries; "active" to resume. Omit to leave unchanged.

Value in"active" | "disabled"

Response Body

`application/json`

curl -X PATCH "https://api.miracle.com/v1/webhooks/endpoints/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "ownerType": "merchant",
    "ownerId": "string",
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "url": "http://example.com",
    "description": "string",
    "events": [
      "string"
    ],
    "status": "active",
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": null
  }
}

Empty