MOmonime
Webhook

Update Webhook

Partially update an existing webhook's configuration and behavior.

patch/v1/webhooks/{id}

Request

  • Base URL
    https://api.monime.io
  • URL
    https://api.monime.io/v1/webhooks/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Unique identifier of the webhook to update.

Headers

Monime-Version'caph.2025-08-23' | 'caph.2025-06-20' nullable

Specifies which version of the Monime API will handle this request.

Monime-Space-Idstring required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Request body

namestring nullable

Updated name for the webhook.

urlstring nullable

New URL to send webhook requests to.

enabledboolean nullable

Enable or disable the webhook.

apiRelease'caph' | 'siriusb' nullable

Updated API release name for webhook payloads.

eventsstring[] nullable

Updated list of events that trigger the webhook.

headersobject nullable

Updated HTTP headers to include in webhook requests.

alertEmailsstring[] nullable

Updated alert email list for delivery failures.

metadataobject nullable

Updated custom metadata for the webhook.

Response

OK

successboolean

Represents the status of the query operation, confirming if it was successful. This field is always true

Example response

{
  "result": {
    "name": "My Ecommerce Webhook"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.