---
title: "Get Webhook"
method: GET
path: "/v1/webhooks/{id}"
tags: ["Webhook"]
---

# Get Webhook

`GET /v1/webhooks/{id}`

Retrieve details of a specific webhook by its ID.

## Path parameters

- `id` string, required — Unique identifier of the webhook to retrieve.

## 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-Id` string, required — The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

## Response `200`

OK

- object
  - `success` boolean — Represents the status of the query operation, confirming if it was successful. This field is always true
  - `messages` unknown[] — Contains a list of messages providing relevant information or feedback related to the query or operation
    - unknown
  - `result` Webhook — 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` 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.
    - `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` string[], nullable — List of event types (e.g., 'payment.created') that will trigger this webhook.
    - `apiRelease` 'caph' | 'siriusb' — The release identifier of the API expected by this webhook. Ensures the webhook receives the latest object schema for a given release cycle.
    - `verificationMethod` union — Method used to verify the integrity of incoming webhook requests.
      - object
        - `type` 'HS256', required — The type of verification method in use. Either 'HS256' for HMAC or 'ES256' for ECDSA.
        - `secret` string, required — The shared secret used to compute and verify the HMAC signature.
      - object
        - `type` 'ES256', required — The type of verification method in use. Either 'HS256' for HMAC or 'ES256' for ECDSA.
        - `publicKey` string — The ECDSA public key used to verify the webhook signature. It is a a PEM-encoded key on the NIST P-256 (prime256v1 / secp256r1) curve.
    - `headers` object, nullable — Optional HTTP headers to include in webhook requests. Useful for passing authentication or context info.
    - `alertEmails` string[], nullable — Email addresses to notify when delivery to this webhook repeatedly fails.
    - `createTime` string, date-time — Timestamp when the webhook was created.
    - `updateTime` string, date-time, nullable — Timestamp when the webhook was last updated.
    - `metadata` object, nullable — Custom metadata for storing additional context or labels for this webhook.

---

[API](https://skmtc.net/monime/apis/monime-api.md) · [All operations](https://skmtc.net/monime/apis/monime-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/monime/monime-api/versions/bd7f875ea428/schema)