Trigger webhook (forward request to configured target)

Request

Project key in URL path identifies the tenant. Configure webhook URL as: /hooks/{projectKey}/{hookId}. Returns wrapped response with execution metadata.

Security

projectKey

Path

hookIdstringrequired

Webhook ID

projectKeyanyrequired

Project API key (same value as x-project-key header)

curl -i -X SEARCH \
  'https://docs.pers.ninja/_mock/swagger/hooks/{projectKey}/{hookId}' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Webhook triggered successfully

Bodyapplication/json

successbooleanrequired

Whether the webhook was successfully triggered and forwarded

executionIdstringrequired

Webhook execution ID for tracking

Example:"550e8400-e29b-41d4-a716-446655440000"

statusCodenumberrequired

HTTP status code from the upstream target

Example:200

durationMsnumberrequired

Time taken to forward and receive response in milliseconds

Example:1234

dataobject

Raw response data from the upstream target (frontend handles parsing)

headersobject

Response headers from upstream (filtered)

Response

{
  "success": true,
  "executionId": "550e8400-e29b-41d4-a716-446655440000",
  "statusCode": 200,
  "durationMs": 1234,
  "data": {},
  "headers": {}
}