Sends a test event to the webhook, even if it is inactive.
The test is attempted once and never retried. Its body has synthetic: true and an empty data.
Parameters
path
- webhookrequiredstring
- The webhook's id,
whk_....
Request body
- event_typerequired"permit.created" | "case.created"
- The event type to send. Need not be one the webhook subscribes to.
- syntheticboolean
- Always
true. Marks the delivery and its body as a test.
Responses
- 201
- Delivery
- The webhook delivery.
- 401
- ProblemDetail
credential_missing,credential_invalidorcredential_expired. The request has no valid credential.- 403
- ProblemDetail
scope_missing,person_required,api_key_not_acceptedorentitlement_missing. The credential or plan does not allow this request.detailnames the reason.- 404
- ProblemDetail
no_such_resource. No object has that id.- 422
- ProblemDetail
parameter_invalid,id_malformedor a cursor code. A parameter is missing or invalid.errorslists each one.- 429
- ProblemDetail
rate_limited. Too many requests. Retry after theRetry-Afterinterval. Nothing is charged.
Credits
Free.
Example request
curl -X POST 'https://api.placestack.com/v1/webhook/018f4b75-6f79-7c6a-8c80-000000000001/delivery' \
-H "Authorization: Bearer $PLACESTACK_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"event_type": "permit.created"
}'Example response
{
"object": "webhook_delivery",
"id": "whd_01h455vb4pex5vsknk084sn02q",
"seq": 1,
"event_type": "permit.created",
"synthetic": true,
"subject": "whk_01h455vb4pex5vsknk084sn02q",
"body": {},
"body_sha256": "3a7bd3e2360a3d29eea436fcfb7e44c735d117c42d1c1835420b6b9942dd4f1b",
"state": "pending",
"attempt_count": 1,
"next_attempt_at": "2026-09-13T12:00:00Z",
"delivered_at": "2026-09-13T12:00:00Z",
"dead_lettered_at": "2026-09-13T12:00:00Z",
"response_status": 1,
"response_body_head": "{\"received\": true}",
"error": "Connection timed out after 10 seconds.",
"created_at": "2026-09-13T12:00:00Z",
"attempt": [
{
"attempt": 1,
"attempted_at": "2026-09-13T12:00:00Z",
"duration_ms": 1,
"timestamp": 1,
"signature": "v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4=",
"response_status": 1,
"response_body_head": "{\"received\": true}",
"error": "Connection timed out after 10 seconds."
}
]
}