Sign in

v1

latestOpenAPI 3.0.32026-07-264414182.7 KB
Webhook

Create Webhook

Create a new webhook with configuration for target URL, events, headers, and security.

post/v1/webhooks

Headers

Idempotency-Keystring required

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

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

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

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.

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

Request body

namestring required

Human-readable name for the webhook configuration.

urlstring required

Target URL that will receive webhook event payloads.

enabledboolean

Flag indicating if the webhook should be active upon creation.

apiRelease'caph' | 'siriusb' required

Defines the target API release for this webhook. A release represents a stable snapshot of the API schema. Ensures the webhook receives the latest object schema for a given release cycle.

eventsstring[] nullable required

List of event types that should trigger this webhook.

headersobject nullable

Optional HTTP headers to include in outbound webhook requests.

alertEmailsstring[] nullable

Optional email addresses to notify on repeated delivery failures.

metadataobject nullable

Custom metadata for tagging or annotating this webhook.

Example request

{
  "name": "My Ecommerce 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"
  }
}