pixellint

RudderStack events check consent management metadata.

HTTP Tracking API JSON on the data plane, and Pixel API GET /pixel/v1/track. Self-hosted data planes on other hosts are directory-only.

Allowed and denied consent lists receive type advice. These checks do not infer event blocking, consent policy or destination behavior.

What this pack matches

Hosts
hosted.rudderlabs.com, dataplane.rudderstack.com, rudderlabs.com
Paths
/v1/identify, /v1/track, /v1/page, /v1/screen, /v1/group, /v1/alias, /v1/batch, /v1/identify/, /v1/track/, /v1/page/, /v1/screen/, /v1/group/, /v1/alias/, /v1/batch/, …/pixel/v1/track…
Vendor docs
www.rudderstack.com/docs/api/http-api/

Rules

Codes are stable. A finding in CI, MCP, or the playground lands on the same id.

Field Required What it checks Rule ids Source
writeKey required The Pixel API authenticates with the source write key in the query. HTTP POST uses basic auth instead, and is a JSON artifact. Applies when {"kind":"present","param":"pixel_api"}. Fix: Add `writeKey` from the HTTP source in the dashboard. vendor.rudderstack.param.writeKey.missing
vendor.rudderstack.param.writeKey.empty
docs
event required Name of the event being tracked. Required on /pixel/v1/track. Applies when {"kind":"present","param":"pixel_api"}. Fix: Set `event` to the action name, such as `Product Viewed`. vendor.rudderstack.param.event.missing
vendor.rudderstack.param.event.empty
docs
anonymousId optional Anonymous identifier. The Pixel API requires `userId` or `anonymousId`. Applies when {"kind":"present","param":"pixel_api"}. vendor.rudderstack.param.anonymousId.empty docs
userId optional Known-user identifier. Alternative to `anonymousId`. Applies when {"kind":"present","param":"pixel_api"}. vendor.rudderstack.param.userId.empty docs
name optional Page or screen name sent for context on a pixel track. Applies when {"kind":"present","param":"pixel_api"}. vendor.rudderstack.param.name.empty docs
context.library.name optional Name of the library or SDK, such as `Rudderstack AMP SDK`. Applies when {"kind":"present","param":"pixel_api"}. vendor.rudderstack.param.context.library.name.empty docs
context.library.version optional Version of the library or SDK. Applies when {"kind":"present","param":"pixel_api"}. vendor.rudderstack.param.context.library.version.empty docs
context.platform optional Platform context, such as `AMP`. Applies when {"kind":"present","param":"pixel_api"}. vendor.rudderstack.param.context.platform.empty docs
context.locale optional User locale, such as the browser language. Applies when {"kind":"present","param":"pixel_api"}. vendor.rudderstack.param.context.locale.empty docs
context.userAgent optional User agent string of the client that fired the pixel. Applies when {"kind":"present","param":"pixel_api"}. vendor.rudderstack.param.context.userAgent.empty docs
context.screen.width optional Screen width in pixels. RudderStack's Pixel API sample sends an integer. Applies when {"kind":"present","param":"pixel_api"}. Fix: Send the width in pixels, such as `1920`. vendor.rudderstack.param.context.screen.width.empty
vendor.rudderstack.param.context.screen.width.invalid
docs
context.screen.height optional Screen height in pixels. RudderStack's Pixel API sample sends an integer. Applies when {"kind":"present","param":"pixel_api"}. Fix: Send the height in pixels, such as `1080`. vendor.rudderstack.param.context.screen.height.empty
vendor.rudderstack.param.context.screen.height.invalid
docs
context.page.path optional Path of the page being viewed. Applies when {"kind":"present","param":"pixel_api"}. vendor.rudderstack.param.context.page.path.empty docs
context.page.url optional Full page URL. RudderStack documents `path`, `url`, `referrer`, and `title` on `context.page`. Applies when {"kind":"present","param":"pixel_api"}. Fix: Send an absolute URL in `context.page.url`, including the scheme. vendor.rudderstack.param.context.page.url.empty
vendor.rudderstack.param.context.page.url.invalid
docs
context.page.referrer optional Referrer URL of the page being viewed. Applies when {"kind":"present","param":"pixel_api"}. Fix: Send an absolute referrer URL, or drop the empty pair. vendor.rudderstack.param.context.page.referrer.empty
vendor.rudderstack.param.context.page.referrer.invalid
docs
context.page.title optional Title of the page being viewed. Applies when {"kind":"present","param":"pixel_api"}. vendor.rudderstack.param.context.page.title.empty docs
pixel_api optional Select the Pixel query contract from its source-published path. docs
identifier_required required The pixel has neither `userId` nor `anonymousId`. RudderStack documents one of the two as required. Fix: Send `userId` for a known user, or `anonymousId` for an unidentified one. vendor.rudderstack.identifier_required docs
type required Each batched call names a documented method. Body scope: batch[]. Native JSON type: string. Fix: Set `type` to identify, track, page, screen, group, or alias. vendor.rudderstack.body.type.missing
vendor.rudderstack.body.type.empty
vendor.rudderstack.body.type.invalid
docs
event optional Name of the user action. Required on a track call. Body scope: batch[]. Native JSON type: string. Fix: Set `event` to the action name, such as `Product Purchased`. vendor.rudderstack.body.event.empty
vendor.rudderstack.body.event.invalid
docs
groupId optional Unique identifier of the group. RudderStack documents it as required on a group call. Body scope: batch[]. Native JSON type: string. Fix: Set `groupId` to the group in your database. vendor.rudderstack.body.groupId.empty
vendor.rudderstack.body.groupId.invalid
docs
previousId optional The previous unique identifier of the user. RudderStack documents it on an alias call. Body scope: batch[]. Native JSON type: string. Fix: Set `previousId` to the id being merged. vendor.rudderstack.body.previousId.empty
vendor.rudderstack.body.previousId.invalid
docs
root optional The vendor documents `` in the request contract. Body scope: batch[]. Native JSON type: object. vendor.rudderstack.body.root.invalid docs
body.track_requires_an_event_name required A `track` call carries no `event`. RudderStack documents the event name as required. Body scope: batch[]. Fix: Add the event name to the call. vendor.rudderstack.body.track_requires_an_event_name docs
body.group_requires_group_id required A `group` call carries no `groupId`. RudderStack documents the group id as required. Body scope: batch[]. Fix: Set `groupId` to the group in your database. vendor.rudderstack.body.group_requires_group_id docs
body.alias_requires_previous_id required An `alias` call carries no `previousId`. RudderStack documents the previous unique identifier on alias. Body scope: batch[]. Fix: Set `previousId` to the id being merged. vendor.rudderstack.body.alias_requires_previous_id docs
userId optional Unique identifier for the user. Either this or `anonymousId` is required. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.userId.empty
vendor.rudderstack.body.userId.invalid
docs
anonymousId optional Stands in for a user id when there is none. Either this or `userId` is required. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.anonymousId.empty
vendor.rudderstack.body.anonymousId.invalid
docs
timestamp optional RudderStack documents timestamp as ISO 8601 `yyyy-MM-ddTHH:mm:ss.SSSZ`. Body scope: ["batch[]",""]. Native JSON type: string. Fix: Send an ISO 8601 timestamp such as `2022-02-01T19:14:18.381Z`. vendor.rudderstack.body.timestamp.empty
vendor.rudderstack.body.timestamp.invalid
docs
sentAt optional RudderStack documents `sentAt` as the client send time, used with `anonymousId` to keep event order. Body scope: ["batch[]",""]. Native JSON type: string. Fix: Send an ISO 8601 timestamp such as `2022-02-01T19:14:18.381Z`. vendor.rudderstack.body.sentAt.empty
vendor.rudderstack.body.sentAt.invalid
docs
context.ip optional It is the visitor IP, sent unhashed. RudderStack's HTTP samples send a raw address. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.ip.empty
vendor.rudderstack.body.context.ip.invalid
docs
name optional Name of the page or screen. RudderStack's HTTP page and screen samples send it. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.name.empty
vendor.rudderstack.body.name.invalid
docs
context.library.name optional Name of the library that produced the call. RudderStack's HTTP samples send `http`. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.library.name.empty
vendor.rudderstack.body.context.library.name.invalid
docs
properties.revenue optional Amount associated with the event. RudderStack's HTTP track sample sends a decimal number such as `4.99`. Body scope: ["batch[]",""]. Native JSON type: number. Fix: Send a number such as `4.99`, with no currency symbol. vendor.rudderstack.body.properties.revenue.empty
vendor.rudderstack.body.properties.revenue.invalid
docs
properties.path optional Path of the page being viewed. RudderStack's HTTP page sample sends it on `properties`. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.properties.path.empty
vendor.rudderstack.body.properties.path.invalid
docs
properties.title optional Title of the page being viewed. RudderStack's HTTP page sample sends it on `properties`. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.properties.title.empty
vendor.rudderstack.body.properties.title.invalid
docs
context optional The vendor documents `context` in the request contract. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.context.invalid docs
context.library optional The vendor documents `context.library` in the request contract. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.context.library.invalid docs
context.page optional The vendor documents `context.page` in the request contract. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.context.page.invalid docs
properties optional The vendor documents `properties` in the request contract. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.properties.invalid docs
traits optional The vendor documents `traits` in the request contract. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.traits.invalid docs
integrations optional The vendor documents `integrations` in the request contract. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.integrations.invalid docs
type optional Body scope: ["batch[]",""]. docs
context.app optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.context.app.invalid docs
context.campaign optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.context.campaign.invalid docs
context.device optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.context.device.invalid docs
context.network optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.context.network.invalid docs
context.os optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.context.os.invalid docs
context.screen optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.context.screen.invalid docs
context.traits optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.context.traits.invalid docs
context.app.name optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.app.name.invalid docs
context.app.version optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.app.version.invalid docs
context.app.build optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.app.build.invalid docs
context.app.namespace optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.app.namespace.invalid docs
context.campaign.name optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.campaign.name.invalid docs
context.campaign.source optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.campaign.source.invalid docs
context.campaign.medium optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.campaign.medium.invalid docs
context.campaign.term optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.campaign.term.invalid docs
context.campaign.content optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.campaign.content.invalid docs
context.device.id optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.device.id.invalid docs
context.device.advertisingId optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.device.advertisingId.invalid docs
context.device.manufacturer optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.device.manufacturer.invalid docs
context.device.model optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.device.model.invalid docs
context.device.name optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.device.name.invalid docs
context.device.type optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.device.type.invalid docs
context.device.version optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.device.version.invalid docs
context.os.name optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.os.name.invalid docs
context.os.version optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.os.version.invalid docs
context.page.path optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.page.path.invalid docs
context.page.referrer optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.page.referrer.invalid docs
context.page.search optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.page.search.invalid docs
context.page.title optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.page.title.invalid docs
context.page.url optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.page.url.invalid docs
context.library.version optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.library.version.invalid docs
context.device.adTrackingEnabled optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: boolean. vendor.rudderstack.body.context.device.adTrackingEnabled.invalid docs
context.network.carrier optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.network.carrier.invalid docs
context.network.bluetooth optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: boolean. vendor.rudderstack.body.context.network.bluetooth.invalid docs
context.network.cellular optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: boolean. vendor.rudderstack.body.context.network.cellular.invalid docs
context.network.wifi optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: boolean. vendor.rudderstack.body.context.network.wifi.invalid docs
context.screen.density optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: number. vendor.rudderstack.body.context.screen.density.invalid docs
context.screen.height optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: number. vendor.rudderstack.body.context.screen.height.invalid docs
context.screen.width optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: number. vendor.rudderstack.body.context.screen.width.invalid docs
context.screen.innerHeight optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: number. vendor.rudderstack.body.context.screen.innerHeight.invalid docs
context.screen.innerWidth optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: number. vendor.rudderstack.body.context.screen.innerWidth.invalid docs
context.timezone optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.timezone.invalid docs
context.userAgent optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.userAgent.invalid docs
context.locale optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.locale.invalid docs
messageId optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.messageId.invalid docs
category optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.category.invalid docs
originalTimestamp optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.originalTimestamp.empty
vendor.rudderstack.body.originalTimestamp.invalid
docs
receivedAt optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.receivedAt.empty
vendor.rudderstack.body.receivedAt.invalid
docs
integrations.All optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: boolean. vendor.rudderstack.body.integrations.All.invalid docs
destination_settings… optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: boolean or object. vendor.rudderstack.body.destination_settings.invalid docs
context.page.initial_referrer optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.page.initial_referrer.invalid docs
context.page.initial_referring_domain optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.page.initial_referring_domain.invalid docs
context.page.referring_domain optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.page.referring_domain.invalid docs
context.page.tab_url optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.context.page.tab_url.invalid docs
channel optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.channel.empty
vendor.rudderstack.body.channel.invalid
docs
request_ip optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: string. vendor.rudderstack.body.request_ip.empty
vendor.rudderstack.body.request_ip.invalid
docs
context.externalId optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: array. vendor.rudderstack.body.context.externalId.invalid docs
context.externalId[] optional Published common context field; validated when supplied. Body scope: ["batch[]",""]. Native JSON type: object. vendor.rudderstack.body.context.externalId[].invalid docs
context.consentManagement optional The documented SDK consent stamp is an optional object. This checks submitted metadata, not whether a destination is gated. Body scope: ["batch[]",""]. Presence diagnostic severity: warning. Native JSON type: object. vendor.rudderstack.body.context.consentManagement.invalid docs
context.consentManagement.provider optional Provider names remain open across SDK profiles. No universal custom-provider enum is inferred from mobile examples. Body scope: ["batch[]",""]. Presence diagnostic severity: warning. Native JSON type: string. vendor.rudderstack.body.context.consentManagement.provider.invalid docs
context.consentManagement.allowedConsentIds optional The published consent stamp uses a list of allowed category ID strings. Empty lists and category membership remain integration-specific. Body scope: ["batch[]",""]. Presence diagnostic severity: warning. Native JSON type: array. vendor.rudderstack.body.context.consentManagement.allowedConsentIds.invalid docs
context.consentManagement.allowedConsentIds[] optional A consent category ID is a string. Case, emptiness, repetitions and configured meaning remain open. Body scope: ["batch[]",""]. Presence diagnostic severity: warning. Native JSON type: string. vendor.rudderstack.body.context.consentManagement.allowedConsentIds[].invalid docs
context.consentManagement.deniedConsentIds optional The published consent stamp records denied category IDs in a string list. Its presence alone does not establish destination blocking. Body scope: ["batch[]",""]. Presence diagnostic severity: warning. Native JSON type: array. vendor.rudderstack.body.context.consentManagement.deniedConsentIds.invalid docs
context.consentManagement.deniedConsentIds[] optional A denied category ID is a string. Cross-list overlap and dashboard resolution are not inferred. Body scope: ["batch[]",""]. Presence diagnostic severity: warning. Native JSON type: string. vendor.rudderstack.body.context.consentManagement.deniedConsentIds[].invalid docs
body.call_needs_an_identifier required The call carries neither `userId` nor `anonymousId`. RudderStack documents one of the two as required. Body scope: ["batch[]",""]. Fix: Send `userId` for a known user, or `anonymousId` for an unidentified one. vendor.rudderstack.body.call_needs_an_identifier docs
body.hashed_plaintext_field required `context.ip` looks like a SHA-256 digest, but RudderStack documents it as an IP address. Body scope: ["batch[]",""]. Fix: Send the raw IP address. vendor.rudderstack.body.hashed_plaintext_field docs
body.alias_requires_user_id required The request does not satisfy the documented alias requires user id requirement. Body scope: ["batch[]",""]. vendor.rudderstack.body.alias_requires_user_id docs
event optional Name of the user action. Required on a track call. Native JSON type: string. Fix: Set `event` to the action name, such as `Product Purchased`. vendor.rudderstack.body.event.empty
vendor.rudderstack.body.event.invalid
docs
type optional The vendor documents `type` in the request contract. Native JSON type: string. vendor.rudderstack.body.type.empty
vendor.rudderstack.body.type.invalid
docs
groupId optional The vendor documents `groupId` in the request contract. Native JSON type: string. vendor.rudderstack.body.groupId.invalid docs
previousId optional The vendor documents `previousId` in the request contract. Native JSON type: string. vendor.rudderstack.body.previousId.invalid docs
batch optional The vendor documents `batch` in the request contract. Native JSON type: array. Minimum array items: 1. vendor.rudderstack.body.batch.invalid docs
batch[] optional The vendor documents `batch[]` in the request contract. Native JSON type: object. vendor.rudderstack.body.batch[].invalid docs
root optional A single call or batch envelope is a JSON object. Native JSON type: object. vendor.rudderstack.body.root.invalid docs
body.track_method_required_field required The request does not satisfy the documented track method required field requirement. vendor.rudderstack.body.track_method_required_field docs
body.group_method_required_field required The request does not satisfy the documented group method required field requirement. vendor.rudderstack.body.group_method_required_field docs
body.alias_method_required_field required The request does not satisfy the documented alias method required field requirement. vendor.rudderstack.body.alias_method_required_field docs
root optional Body scope: ["batch[].context.externalId[]","context.externalId[]"]. Native JSON type: object. vendor.rudderstack.body.root.invalid docs
id required Body scope: ["batch[].context.externalId[]","context.externalId[]"]. Native JSON type: string. vendor.rudderstack.body.id.missing
vendor.rudderstack.body.id.invalid
docs
type required Body scope: ["batch[].context.externalId[]","context.externalId[]"]. Native JSON type: string. vendor.rudderstack.body.type.missing
vendor.rudderstack.body.type.invalid
docs
type optional Body scope: ["batch[]",""]. docs
context.library.name optional Body scope: ["batch[]",""]. docs
name recommended The documented HTTP page/screen profile supplies a name. SDK-specific optionality varies, so absence is advisory rather than a rejection rule. Body scope: ["batch[]",""]. Applies when {"kind":"all","conditions":[{"kind":"value_in","param":"type","values":["page","screen"]},{"kind":"value_in","param":"context.library.name","values":["http"]}]}. Presence diagnostic severity: warning. vendor.rudderstack.body.name.missing docs
path required Select the published Pixel or HTTP operation. Complete HTTP capture contract. Native JSON type: string. vendor.rudderstack.http.path.missing
vendor.rudderstack.http.path.empty
vendor.rudderstack.http.path.invalid
docs
method required The HTTP API operations use POST. Complete HTTP capture contract. Applies when {"kind":"not","condition":{"kind":"value_pattern","param":"path","pattern":"/pixel/v1/track/?$"}}. Native JSON type: string. vendor.rudderstack.http.method.missing
vendor.rudderstack.http.method.empty
vendor.rudderstack.http.method.invalid
docs
pixel_method required The Pixel API uses GET. Complete HTTP capture contract. Applies when {"kind":"value_pattern","param":"path","pattern":"/pixel/v1/track/?$"}. Native JSON type: string. vendor.rudderstack.http.pixel_method.missing
vendor.rudderstack.http.pixel_method.empty
vendor.rudderstack.http.pixel_method.invalid
docs
content_type required The HTTP API requires application/json. Complete HTTP capture contract. Applies when {"kind":"not","condition":{"kind":"value_pattern","param":"path","pattern":"/pixel/v1/track/?$"}}. Native JSON type: string. vendor.rudderstack.http.content_type.missing
vendor.rudderstack.http.content_type.empty
vendor.rudderstack.http.content_type.invalid
docs
headers.authorization required RudderStack requires HTTP Basic authentication. Complete HTTP capture contract. Applies when {"kind":"not","condition":{"kind":"value_pattern","param":"path","pattern":"/pixel/v1/track/?$"}}. Native JSON type: string. vendor.rudderstack.http.headers.authorization.missing
vendor.rudderstack.http.headers.authorization.empty
vendor.rudderstack.http.headers.authorization.invalid
docs
authorization_scheme required The HTTP API authenticates through Basic. Complete HTTP capture contract. Applies when {"kind":"not","condition":{"kind":"value_pattern","param":"path","pattern":"/pixel/v1/track/?$"}}. Native JSON type: string. vendor.rudderstack.http.authorization_scheme.missing
vendor.rudderstack.http.authorization_scheme.empty
vendor.rudderstack.http.authorization_scheme.invalid
docs
basic_auth required Basic credentials must decode successfully. Complete HTTP capture contract. Applies when {"kind":"not","condition":{"kind":"value_pattern","param":"path","pattern":"/pixel/v1/track/?$"}}. Native JSON type: object. vendor.rudderstack.http.basic_auth.missing
vendor.rudderstack.http.basic_auth.invalid
docs
basic_auth.username optional Published examples place the write key in the username. Complete HTTP capture contract. Native JSON type: string. vendor.rudderstack.http.basic_auth.username.empty
vendor.rudderstack.http.basic_auth.username.invalid
docs
basic_auth.password optional Published prose instead places the write key in the password; both branches are retained. Complete HTTP capture contract. Native JSON type: string. vendor.rudderstack.http.basic_auth.password.empty
vendor.rudderstack.http.basic_auth.password.invalid
docs
body required HTTP calls post a JSON object. Complete HTTP capture contract. Applies when {"kind":"not","condition":{"kind":"value_pattern","param":"path","pattern":"/pixel/v1/track/?$"}}. Native JSON type: object. vendor.rudderstack.http.body.missing
vendor.rudderstack.http.body.invalid
docs
body.event required Track requires its event even when the route infers the method. Complete HTTP capture contract. Applies when {"kind":"value_pattern","param":"path","pattern":"^/v1/track/?$"}. Native JSON type: string. vendor.rudderstack.http.body.event.missing
vendor.rudderstack.http.body.event.empty
vendor.rudderstack.http.body.event.invalid
docs
body.groupId required Group requires its group ID. Complete HTTP capture contract. Applies when {"kind":"value_pattern","param":"path","pattern":"^/v1/group/?$"}. Native JSON type: string. vendor.rudderstack.http.body.groupId.missing
vendor.rudderstack.http.body.groupId.empty
vendor.rudderstack.http.body.groupId.invalid
docs
body.previousId required Alias requires its previous ID. Complete HTTP capture contract. Applies when {"kind":"value_pattern","param":"path","pattern":"^/v1/alias/?$"}. Native JSON type: string. vendor.rudderstack.http.body.previousId.missing
vendor.rudderstack.http.body.previousId.empty
vendor.rudderstack.http.body.previousId.invalid
docs
body.batch required Batch requires a nonempty event array. Complete HTTP capture contract. Applies when {"kind":"value_pattern","param":"path","pattern":"^/v1/batch/?$"}. Native JSON type: array. Minimum array items: 1. vendor.rudderstack.http.body.batch.missing
vendor.rudderstack.http.body.batch.invalid
docs
body.type optional Complete HTTP capture contract. docs
body.context.library.name optional Complete HTTP capture contract. docs
body.name recommended Infer the documented HTTP page/screen operation from the endpoint when type is absent. Explicit type advice is owned by the body profile to avoid duplicate findings. Complete HTTP capture contract. Applies when {"kind":"all","conditions":[{"kind":"value_pattern","param":"path","pattern":"^/v1/(?:page|screen)/?$"},{"kind":"value_in","param":"body.context.library.name","values":["http"]},{"kind":"not","condition":{"kind":"exists","param":"body.type"}}]}. Presence diagnostic severity: warning. vendor.rudderstack.http.body.name.missing docs
http.basic_write_key_required required The Basic credentials must contain the source write key. Documentation disagrees on its position. Complete HTTP capture contract. vendor.rudderstack.http.basic_write_key_required docs

Validate a payload

pixellint validate request @request.json --rulepack vendor/rudderstack

Try this failing payload in the playground. An example with a validation finding.

{
  "url": "https://hosted.rudderlabs.com/v1/track",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic c3ludGhldGljOg=="
  },
  "body": "{\"userId\":\"synthetic-user\",\"event\":\"Synthetic Event\",\"context\":{\"library\":{\"name\":\"http\"},\"consentManagement\":{\"provider\":1}}}"
}

cargo install pixellint · npm install pixellint