Skip to main content
The simulate event endpoint allows you to test your webhook integration without waiting for a scheduled monitor run.

Endpoint

POST /v1alpha/monitors/{monitor_id}/simulate_event

Query Parameters

ParameterTypeDefaultDescription
event_typestringmonitor.event.detectedEvent type to simulate. One of: monitor.event.detected, monitor.execution.completed, monitor.execution.failed

Response

Returns 204 No Content on success.

Errors

StatusDescription
400Webhook not configured for this monitor
404Monitor not found

Usage

curl --request POST \
  --url "https://api.parallel.ai/v1alpha/monitors/<monitor_id>/simulate_event?event_type=monitor.event.detected" \
  --header "x-api-key: $PARALLEL_API_KEY"

Test Event Groups

When you simulate a monitor.event.detected event, the webhook payload includes a test event_group_id. You can retrieve this test event group using the standard endpoint:
GET /v1alpha/monitors/{monitor_id}/event_groups/{event_group_id}
Test event group IDs return dummy event data, allowing you to verify your full webhook processing pipeline—from receiving the webhook to fetching event details.
curl --request GET \
  --url "https://api.parallel.ai/v1alpha/monitors/<monitor_id>/event_groups/<test_event_group_id>" \
  --header "x-api-key: $PARALLEL_API_KEY"
Response:
{
    "events": [
        {
            "type": "event",
            "event_group_id": "test_abc",
            "output": "",
            "event_date": "2025-12-05",
            "source_urls": [
                "https://test.example.com"
            ],
            "result": {
                "type": "text",
                "content": "This is a test event."
            }
        }
    ]
}
  • Webhooks: Configure webhooks and understand event payloads
  • Events: Event types and event groups