Skip to main content
PATCH
Update Webhook

Authorizations

Authorization
string
header
required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Headers

Monime-Version
enum<string> | null

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

Available options:
caph.2025-08-23,
caph.2025-06-20
Monime-Space-Id
string
required

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

Maximum string length: 64
Pattern: ^spc-.*$

Path Parameters

id
string
required

Unique identifier of the webhook to update.

Pattern: ^whk-.*$

Body

application/json

Partially update an existing webhook's configuration and behavior.

name
string | null

Updated name for the webhook.

Required string length: 1 - 100
url
string | null

New URL to send webhook requests to.

Maximum string length: 255
enabled
boolean | null

Enable or disable the webhook.

apiRelease
enum<string> | null

Updated API release name for webhook payloads.

Available options:
caph,
siriusb
events
string[] | null

Updated list of events that trigger the webhook.

Required array length: 1 - 100 elements
headers
object | null

Updated HTTP headers to include in webhook requests.

alertEmails
string[] | null

Updated alert email list for delivery failures.

Maximum array length: 2
metadata
object | null

Updated custom metadata for the webhook.

Response

200 - application/json

OK

success
boolean

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

messages
any[]

Contains a list of messages providing relevant information or feedback related to the query or operation

result
Webhook · object

A Webhook is a user-defined HTTP endpoint that Monime invokes with a POST request whenever specific events occur, such as payment.completed or payout.failed.
Webhooks allow you to receive real-time notifications and integrate Monime’s event stream directly into your own systems.

Use Cases

  • Realtime Payment Updates
    Receive an immediate notification when a payment succeeds and update your user’s dashboard without polling the API.

  • Automated Payout Reconciliation
    Trigger accounting workflows or ERP system updates when a payout is marked as completed or failed.

  • Fraud & Risk Monitoring
    Stream payment events into your fraud detection system as they happen.