Block or unblock a custom event
Blocks or unblocks storing a custom event, named URL-encoded in the path.
Guide: Events
AuthorizationBearer <token>
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
projectId*string
The project's id, proj_.... A secret key works only in the project it belongs to.
eventName*string
The custom event's name, URL-encoded. Surrounding spaces are trimmed.
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
isBlocked*boolean
Whether the project refuses to store the event.
Examples
curl -X PUT "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/ingest-policy/custom-events/debug_tap" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "isBlocked": true }'{ "eventName": "debug_tap", "isBlocked": true}{ "error": { "type": "invalid_request", "code": "reserved_event_name", "message": "Name a custom event. Built-in ($-prefixed) events are turned on and off by their setting instead.", "param": "eventName" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | reserved_event_name | For a blank or $-prefixed name; built-in events are turned on and off by their setting instead. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Ingest policy
Something wrong or missing on this page? Tell us by email or on Discord.