{
    "id": null,
    "name": "My Ecommerce Webhook",
    "url": null,
    "enabled": null,
    "events": [],
    "apiRelease": "caph",
    "verificationMethod": {
        "type": "ES256"
    },
    "headers": null,
    "alertEmails": [],
    "createTime": null,
    "updateTime": null,
    "metadata": null
}
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.     
{
    "id": null,
    "name": "My Ecommerce Webhook",
    "url": null,
    "enabled": null,
    "events": [],
    "apiRelease": "caph",
    "verificationMethod": {
        "type": "ES256"
    },
    "headers": null,
    "alertEmails": [],
    "createTime": null,
    "updateTime": null,
    "metadata": null
}
​
📋
Properties
​
id
string
Unique identifier of the webhook object.
​
name
string
Human-readable name for the webhook configuration. Useful for identifying its purpose in dashboards or logs.Example: My Ecommerce Webhook
​
url
string
Publicly accessible URL that will receive event POST requests from this webhook.
​
enabled
boolean
Indicates whether the webhook is currently enabled. If false, events will not be sent.
​
events
array
List of event types (e.g., ‘payment.created’) that will trigger this webhook.
​
apiRelease
enum<string>
The release identifier of the API expected by this webhook. Ensures the webhook receives the latest object schema for a given release cycle.Available options: caph siriusb
​
verificationMethod
object
Method used to verify the integrity of incoming webhook requests.
​
headers
object
Optional HTTP headers to include in webhook requests. Useful for passing authentication or context info.
​
alertEmails
array
Email addresses to notify when delivery to this webhook repeatedly fails.
​
createTime
string
Timestamp when the webhook was created.
​
updateTime
string
Timestamp when the webhook was last updated.
​
metadata
object
Custom metadata for storing additional context or labels for this webhook.