VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
Retrieve the ingest policy
Turn a built-in event on or off
Block or unblock a custom event

Turn a built-in event on or off

Turns storing a built-in event on or off.

Guide: Events

PUT
/api/v1/projects/{projectId}/ingest-policy/builtin-events/{key}

Authorization

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.

key*string

The built-in event setting's key: a built-in event's name, such as $screen, or revenue for the revenue events.

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

isEnabled*boolean

Whether the project stores the setting's events.

Examples

curl -X PUT "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/ingest-policy/builtin-events/$screen" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "isEnabled": false  }'
{  "key": "$screen",  "name": "Screen views",  "description": "Every screen the user lands on, with the previous screen and time spent there. The highest-volume built-in event.",  "eventNames": [    "$screen"  ],  "isEnabled": false,  "isDefaultEnabled": true,  "isOverridden": true,  "warning": null}
{  "error": {    "type": "invalid_request",    "code": "invalid_body",    "message": "The request body is invalid: Missing key\n  at [\"isEnabled\"]"  }}
{  "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": "builtin_event_not_found",    "message": "There is no built-in event setting $app_crashed.",    "param": "key"  }}

{  "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

StatustypecodeWhen
404not_foundbuiltin_event_not_foundFor a key that names no built-in event setting.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Ingest policy

  • Retrieve the ingest policy GET
  • Block or unblock a custom event PUT

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousRetrieve the ingest policyNextBlock or unblock a custom event

On this page

AuthorizationPath parametersRequest bodyExamplesResponse bodyErrorsMore in Ingest policy