> For the complete documentation index, see [llms.txt](https://docs.vcheckglobal.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vcheckglobal.com/api-reference/monitoring/monitoring-webhooks.md). # Monitoring Webhooks Register and manage webhook endpoints to receive real-time Monitoring alert notifications. ## Get Webhook Config > Retrieve the current monitoring callback URL configuration.\ > \ > Sensitive credential values are masked in the response (e.g. \`my-\*\*\*ret\`).\ > \ > \### Response fields\ > \ > \| Field | Type | Description |\ > \|-------|------|-------------|\ > \| \`callback\_url\` | string | The registered HTTPS endpoint |\ > \| \`auth\_method\` | string | Authentication method (\`HMAC\_SHA256\`, \`BEARER\_TOKEN\`, \`HEADER\_API\_KEY\`) |\ > \| \`auth\_credentials\` | object | Masked credentials |\ > \| \`event\_types\` | array\[string] | Subscribed event types |\ > \| \`requests\_per\_second\` | integer | Configured webhook delivery rate (default: 5 requests/second) |\ > \| \`throttle\_delay\_hours\` | integer | Suspension period in hours after a delivery failure (default: 1, range: 1-6) |\ > \| \`is\_active\` | boolean | Whether the callback URL is currently active |\ > \| \`created\_at\` | string (ISO 8601) | When the callback URL was registered |
```json {"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Webhooks","description":"Register and manage webhook endpoints to receive real-time Monitoring alert notifications."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/monitoring/webhook":{"get":{"tags":["Monitoring Webhooks"],"operationId":"getMonitoringCallbackUrlConfiguration","summary":"Get Webhook Config","description":"Retrieve the current monitoring callback URL configuration.\n\nSensitive credential values are masked in the response (e.g. `my-***ret`).\n\n### Response fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `callback_url` | string | The registered HTTPS endpoint |\n| `auth_method` | string | Authentication method (`HMAC_SHA256`, `BEARER_TOKEN`, `HEADER_API_KEY`) |\n| `auth_credentials` | object | Masked credentials |\n| `event_types` | array[string] | Subscribed event types |\n| `requests_per_second` | integer | Configured webhook delivery rate (default: 5 requests/second) |\n| `throttle_delay_hours` | integer | Suspension period in hours after a delivery failure (default: 1, range: 1-6) |\n| `is_active` | boolean | Whether the callback URL is currently active |\n| `created_at` | string (ISO 8601) | When the callback URL was registered |\n","responses":{"200":{"description":"Callback URL configuration retrieved with masked credentials","content":{"application/json":{"schema":{"type":"object","properties":{"webhook_id":{"description":"Unique identifier for this webhook registration","type":"string"},"callback_url":{"description":"Registered HTTPS endpoint","type":"string"},"auth_method":{"description":"Authentication method (HMAC_SHA256, BEARER_TOKEN, HEADER_API_KEY)","type":"string"},"auth_credentials":{"description":"Masked credentials","type":"object"},"event_types":{"description":"Subscribed event types","type":"array","items":{"type":"string"}},"requests_per_second":{"description":"Configure webhook delivery rate (default: 5 request/seconds)","type":"integer"},"throttle_delay_hours":{"description":"Suspension period in hours after a delivery failure. When an error response is received, webhook delivery is suspended for this duration. Deliveries due during suspension are skipped, not queued. Delivery resumes automatically after the delay expires (default: 1 hour, range: 1-6)","type":"integer"},"is_active":{"description":"Whether the webhook is currently active","type":"boolean"},"created_at":{"description":"ISO 8601 timestamp of registration","type":"string"},"updated_at":{"description":"ISO 8601 timestamp of last update","type":"string"}}}}}},"403":{"description":"Endpoint disabled or insufficient scope"},"404":{"description":"No callback URL is registered for this account","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code","type":"string"},"message":{"description":"Human-readable error description","type":"string"}}}}}}}},"500":{"description":"Internal error - retry the request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code","type":"string"},"message":{"description":"Human-readable error description","type":"string"}}}}}}}}}}}}} ``` ## Register Webhook > Register a new webhook endpoint for receiving monitoring alerts.\ > \ > If a previously deactivated configuration exists, this reactivates it with the new settings while preserving the original webhook ID and creation timestamp.\ > \ > The webhook will start receiving alerts of the specified types as soon as it is registered.\ > \ > \### Request body\ > \ > \| Field | Type | Required | Description |\ > \|-------|------|----------|-------------|\ > \| \`callback\_url\` | string (URL) | Yes | HTTPS endpoint that will receive event payloads |\ > \| \`auth\_method\` | string | Yes | Authentication method: \`hmac\_sha256\`, \`bearer\_token\`, or \`header\_api\_key\` |\ > \| \`auth\_credentials\` | object | Yes | Credentials for the chosen auth method (e.g. \`{"secret": "..."}\`) |\ > \| \`event\_types\` | array\[string] | Yes | Event types to subscribe to (e.g. \`\["SEND\_MONITORING\_ALERT"]\`) |\ > \ > \### Error codes\ > \ > \| Code | HTTP Status | Description |\ > \|------|-------------|-------------|\ > \| \`DUPLICATE\_REQUEST\` | 409 | A webhook is already registered for this account. Use PATCH to update. |\ > \| \`CLIENT\_NOT\_REGISTERED\` | 404 | No webhook-capable client found for this account. |\ > \| \`INTERNAL\_ERROR\` | 500 | Encryption or internal failure. Retry the request. |\ > \ > \### Response fields\ > \ > \| Field | Type | Description |\ > \|-------|------|-------------|\ > \| \`callback\_url\` | string | The registered HTTPS endpoint |\ > \| \`auth\_method\` | string | Authentication method (\`HMAC\_SHA256\`, \`BEARER\_TOKEN\`, \`HEADER\_API\_KEY\`) |\ > \| \`auth\_credentials\` | object | Masked credentials |\ > \| \`event\_types\` | array\[string] | Subscribed event types |\ > \| \`requests\_per\_second\` | integer | Configured webhook delivery rate (default: 5 requests/second) |\ > \| \`throttle\_delay\_hours\` | integer | Suspension period in hours after a delivery failure (default: 1, range: 1-6) |\ > \| \`is\_active\` | boolean | Whether the callback URL is currently active |\ > \| \`created\_at\` | string (ISO 8601) | When the callback URL was registered |\ > \| \`updated\_at\` | string (ISO 8601) | When the callback URL was last updated |\ > \ > \### Example Request\ > \ > \`\`\`json\ > {\ > "callback\_url": " > "auth\_method": "hmac\_sha256",\ > "auth\_credentials": {"secret": "my-secret-key"},\ > "event\_types": \["SEND\_MONITORING\_ALERT"]\ > }\ > \`\`\`
````json {"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Webhooks","description":"Register and manage webhook endpoints to receive real-time Monitoring alert notifications."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}},"schemas":{"MonitoringWebhookRegisterRequest":{"type":"object","required":["callback_url","auth_method","auth_credentials","event_types"],"properties":{"callback_url":{"type":"string","format":"uri","description":"HTTPS endpoint that will receive event payloads."},"auth_method":{"type":"string","enum":["hmac_sha256","bearer_token","header_api_key"],"description":"Authentication method Vcheck uses when calling your endpoint."},"auth_credentials":{"type":"object","description":"Credentials for the chosen auth method, for example `{\"secret\": \"...\"}`."},"event_types":{"type":"array","items":{"type":"string"},"description":"Event types to subscribe to, for example `[\"SEND_MONITORING_ALERT\"]`."}},"additionalProperties":false}}},"paths":{"/monitoring/webhook":{"post":{"tags":["Monitoring Webhooks"],"operationId":"registerMonitoringCallbackUrl","summary":"Register Webhook","description":"Register a new webhook endpoint for receiving monitoring alerts.\n\nIf a previously deactivated configuration exists, this reactivates it with the new settings while preserving the original webhook ID and creation timestamp.\n\nThe webhook will start receiving alerts of the specified types as soon as it is registered.\n\n### Request body\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `callback_url` | string (URL) | Yes | HTTPS endpoint that will receive event payloads |\n| `auth_method` | string | Yes | Authentication method: `hmac_sha256`, `bearer_token`, or `header_api_key` |\n| `auth_credentials` | object | Yes | Credentials for the chosen auth method (e.g. `{\"secret\": \"...\"}`) |\n| `event_types` | array[string] | Yes | Event types to subscribe to (e.g. `[\"SEND_MONITORING_ALERT\"]`) |\n\n### Error codes\n\n| Code | HTTP Status | Description |\n|------|-------------|-------------|\n| `DUPLICATE_REQUEST` | 409 | A webhook is already registered for this account. Use PATCH to update. |\n| `CLIENT_NOT_REGISTERED` | 404 | No webhook-capable client found for this account. |\n| `INTERNAL_ERROR` | 500 | Encryption or internal failure. Retry the request. |\n\n### Response fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `callback_url` | string | The registered HTTPS endpoint |\n| `auth_method` | string | Authentication method (`HMAC_SHA256`, `BEARER_TOKEN`, `HEADER_API_KEY`) |\n| `auth_credentials` | object | Masked credentials |\n| `event_types` | array[string] | Subscribed event types |\n| `requests_per_second` | integer | Configured webhook delivery rate (default: 5 requests/second) |\n| `throttle_delay_hours` | integer | Suspension period in hours after a delivery failure (default: 1, range: 1-6) |\n| `is_active` | boolean | Whether the callback URL is currently active |\n| `created_at` | string (ISO 8601) | When the callback URL was registered |\n| `updated_at` | string (ISO 8601) | When the callback URL was last updated |\n\n### Example Request\n\n```json\n{\n \"callback_url\": \"https://your-domain.com/webhooks/monitoring\",\n \"auth_method\": \"hmac_sha256\",\n \"auth_credentials\": {\"secret\": \"my-secret-key\"},\n \"event_types\": [\"SEND_MONITORING_ALERT\"]\n}\n```\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringWebhookRegisterRequest"}}}},"responses":{"201":{"description":"Callback URL registered successfully","content":{"application/json":{"schema":{"type":"object","properties":{"webhook_id":{"description":"Unique identifier for this webhook registration","type":"string"},"callback_url":{"description":"Registered HTTPS endpoint","type":"string"},"auth_method":{"description":"Authentication method (HMAC_SHA256, BEARER_TOKEN, HEADER_API_KEY)","type":"string"},"auth_credentials":{"description":"Masked credentials","type":"object"},"event_types":{"description":"Subscribed event types","type":"array","items":{"type":"string"}},"requests_per_second":{"description":"Configure webhook delivery rate (default: 5 request/seconds)","type":"integer"},"throttle_delay_hours":{"description":"Suspension period in hours after a delivery failure. When an error response is received, webhook delivery is suspended for this duration. Deliveries due during suspension are skipped, not queued. Delivery resumes automatically after the delay expires (default: 1 hour, range: 1-6)","type":"integer"},"is_active":{"description":"Whether the webhook is currently active","type":"boolean"},"created_at":{"description":"ISO 8601 timestamp of registration","type":"string"},"updated_at":{"description":"ISO 8601 timestamp of last update","type":"string"}}}}}},"400":{"description":"Validation error - check the response body for field-level details"},"403":{"description":"Endpoint disabled or insufficient scope"},"404":{"description":"No callback URL capable client found for this account","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code","type":"string"},"message":{"description":"Human-readable error description","type":"string"}}}}}}}},"409":{"description":"A callback URL is already registered. Use PATCH to update.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code","type":"string"},"message":{"description":"Human-readable error description","type":"string"}}}}}}}},"500":{"description":"Internal error - retry the request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code","type":"string"},"message":{"description":"Human-readable error description","type":"string"}}}}}}}}}}}}} ```` ## Deactivate Webhook > Deactivate the monitoring callback URL.\ > \ > No further monitoring alerts will be delivered to the configured callback URL.\ > \ > The configuration is preserved and can be reactivated via POST.\ > \ > \### Response fields\ > \ > \| Field | Type | Description |\ > \|-------|------|-------------|\ > \| \`detail\` | string | Confirmation message |
```json {"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Webhooks","description":"Register and manage webhook endpoints to receive real-time Monitoring alert notifications."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/monitoring/webhook":{"delete":{"tags":["Monitoring Webhooks"],"operationId":"deactivateMonitoringCallbackUrl","summary":"Deactivate Webhook","description":"Deactivate the monitoring callback URL.\n\nNo further monitoring alerts will be delivered to the configured callback URL.\n\nThe configuration is preserved and can be reactivated via POST.\n\n### Response fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `detail` | string | Confirmation message |\n","responses":{"200":{"description":"Callback URL deactivated successfully","content":{"application/json":{}}},"403":{"description":"Endpoint disabled or insufficient scope"},"404":{"description":"No callback URL is registered for this account","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code","type":"string"},"message":{"description":"Human-readable error description","type":"string"}}}}}}}},"500":{"description":"Internal error - retry the request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code","type":"string"},"message":{"description":"Human-readable error description","type":"string"}}}}}}}}}}}}} ``` ## Update Webhook > Partially update the monitoring callback URL configuration.\ > \ > Send only the fields you want to change. Omitted fields remain unchanged.\ > \ > \### Request body (all fields optional)\ > \ > \| Field | Type | Description |\ > \|-------|------|-------------|\ > \| \`callback\_url\` | string (URL) | New HTTPS endpoint for alert delivery |\ > \| \`auth\_method\` | string | New authentication method: \`hmac\_sha256\`, \`bearer\_token\`, or \`header\_api\_key\` |\ > \| \`auth\_credentials\` | object | New credentials for the chosen auth method |\ > \| \`event\_types\` | array\[string] | Updated list of event types to subscribe to |\ > \ > \### Response fields\ > \ > \| Field | Type | Description |\ > \|-------|------|-------------|\ > \| \`callback\_url\` | string | The registered HTTPS endpoint |\ > \| \`auth\_method\` | string | Authentication method (\`HMAC\_SHA256\`, \`BEARER\_TOKEN\`, \`HEADER\_API\_KEY\`) |\ > \| \`auth\_credentials\` | object | Masked credentials |\ > \| \`event\_types\` | array\[string] | Subscribed event types |\ > \| \`requests\_per\_second\` | integer | Configured webhook delivery rate |\ > \| \`throttle\_delay\_hours\` | integer | Suspension period in hours after a delivery failure |\ > \| \`is\_active\` | boolean | Whether the callback URL is currently active |\ > \| \`created\_at\` | string (ISO 8601) | When the callback URL was registered |\ > \| \`updated\_at\` | string (ISO 8601) | When the callback URL was last updated |\ > \ > \### Example Request\ > \ > \`\`\`json\ > {\ > "callback\_url": " > "auth\_method": "bearer\_token",\ > "auth\_credentials": {"token": "new-bearer-token"}\ > }\ > \`\`\`
````json {"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Webhooks","description":"Register and manage webhook endpoints to receive real-time Monitoring alert notifications."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}},"schemas":{"MonitoringWebhookUpdateRequest":{"type":"object","description":"Send only the fields you want to change. Omitted fields remain unchanged.","properties":{"callback_url":{"type":"string","format":"uri","description":"HTTPS endpoint that will receive event payloads."},"auth_method":{"type":"string","enum":["hmac_sha256","bearer_token","header_api_key"],"description":"Authentication method Vcheck uses when calling your endpoint."},"auth_credentials":{"type":"object","description":"Credentials for the chosen auth method, for example `{\"secret\": \"...\"}`."},"event_types":{"type":"array","items":{"type":"string"},"description":"Event types to subscribe to, for example `[\"SEND_MONITORING_ALERT\"]`."}},"additionalProperties":false}}},"paths":{"/monitoring/webhook":{"patch":{"tags":["Monitoring Webhooks"],"operationId":"updateMonitoringCallbackUrlConfiguration","summary":"Update Webhook","description":"Partially update the monitoring callback URL configuration.\n\nSend only the fields you want to change. Omitted fields remain unchanged.\n\n### Request body (all fields optional)\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `callback_url` | string (URL) | New HTTPS endpoint for alert delivery |\n| `auth_method` | string | New authentication method: `hmac_sha256`, `bearer_token`, or `header_api_key` |\n| `auth_credentials` | object | New credentials for the chosen auth method |\n| `event_types` | array[string] | Updated list of event types to subscribe to |\n\n### Response fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `callback_url` | string | The registered HTTPS endpoint |\n| `auth_method` | string | Authentication method (`HMAC_SHA256`, `BEARER_TOKEN`, `HEADER_API_KEY`) |\n| `auth_credentials` | object | Masked credentials |\n| `event_types` | array[string] | Subscribed event types |\n| `requests_per_second` | integer | Configured webhook delivery rate |\n| `throttle_delay_hours` | integer | Suspension period in hours after a delivery failure |\n| `is_active` | boolean | Whether the callback URL is currently active |\n| `created_at` | string (ISO 8601) | When the callback URL was registered |\n| `updated_at` | string (ISO 8601) | When the callback URL was last updated |\n\n### Example Request\n\n```json\n{\n \"callback_url\": \"https://your-domain.com/webhooks/monitoring-v2\",\n \"auth_method\": \"bearer_token\",\n \"auth_credentials\": {\"token\": \"new-bearer-token\"}\n}\n```\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringWebhookUpdateRequest"}}}},"responses":{"200":{"description":"Callback URL configuration updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"webhook_id":{"description":"Unique identifier for this webhook registration","type":"string"},"callback_url":{"description":"Registered HTTPS endpoint","type":"string"},"auth_method":{"description":"Authentication method (HMAC_SHA256, BEARER_TOKEN, HEADER_API_KEY)","type":"string"},"auth_credentials":{"description":"Masked credentials","type":"object"},"event_types":{"description":"Subscribed event types","type":"array","items":{"type":"string"}},"requests_per_second":{"description":"Configure webhook delivery rate (default: 5 request/seconds)","type":"integer"},"throttle_delay_hours":{"description":"Suspension period in hours after a delivery failure. When an error response is received, webhook delivery is suspended for this duration. Deliveries due during suspension are skipped, not queued. Delivery resumes automatically after the delay expires (default: 1 hour, range: 1-6)","type":"integer"},"is_active":{"description":"Whether the webhook is currently active","type":"boolean"},"created_at":{"description":"ISO 8601 timestamp of registration","type":"string"},"updated_at":{"description":"ISO 8601 timestamp of last update","type":"string"}}}}}},"400":{"description":"Validation error - check the response body for field-level details"},"403":{"description":"Endpoint disabled or insufficient scope"},"404":{"description":"No callback URL capable client found for this account","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code","type":"string"},"message":{"description":"Human-readable error description","type":"string"}}}}}}}},"500":{"description":"Internal error - retry the request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"description":"Machine-readable error code","type":"string"},"message":{"description":"Human-readable error description","type":"string"}}}}}}}}}}}}} ```` ## List Event Types > Returns the list of webhook event types grouped by service.\ > \ > Use the \`event\_type\` values from this response when configuring the \`event\_types\` array in \`POST /v2/monitoring/webhook/\`.\ > \ > \### Response structure\ > \ > The response is an array of objects, one per service:\ > \ > \| Field | Type | Description |\ > \|-------|------|-------------|\ > \| \`service\` | string | Service identifier (\`monitoring\`) |\ > \| \`event\_types\` | array | Available events for this service |\ > \| \`event\_types\[].event\_type\` | string | Machine-readable event type to use in webhook config |\ > \| \`event\_types\[].description\` | string | Human-readable description of when the event fires |
```json {"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Webhooks","description":"Register and manage webhook endpoints to receive real-time Monitoring alert notifications."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/monitoring/events":{"get":{"tags":["Monitoring Webhooks"],"operationId":"getMonitoringWebhookEventTypes","summary":"List Event Types","description":"Returns the list of webhook event types grouped by service.\n\nUse the `event_type` values from this response when configuring the `event_types` array in `POST /v2/monitoring/webhook/`.\n\n### Response structure\n\nThe response is an array of objects, one per service:\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `service` | string | Service identifier (`monitoring`) |\n| `event_types` | array | Available events for this service |\n| `event_types[].event_type` | string | Machine-readable event type to use in webhook config |\n| `event_types[].description` | string | Human-readable description of when the event fires |\n","responses":{"200":{"description":"Webhook event types retrieved successfully.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"service":{"description":"Service type (e.g. `monitoring`, `background_check`).","type":"string"},"event_types":{"description":"Available event types for this service.","type":"array","items":{"type":"object","properties":{"event_type":{"description":"Machine-readable event type identifier to use in webhook `event_types` configuration.","type":"string"},"description":{"description":"Human-readable description of when this event fires.","type":"string"}}}}}}}}}},"403":{"description":"Forbidden - missing or invalid Client-ID credentials, insufficient scope, endpoint disabled via feature flag, or authenticated client has no linked account. Verify the scopes assigned to your credentials.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Authorization or access error message.","type":"string","default":"This endpoint is currently disabled."}}}}}},"500":{"description":"Internal server error - an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Internal server error message.","type":"string","default":"An unexpected error occurred while processing the request."}}}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.vcheckglobal.com/api-reference/monitoring/monitoring-webhooks.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.