Metadata

Rangler does not currently expose a customer writable metadata parameter on public API resources.

This page defines the contract we will use when metadata is added to developer control plane resources.

Use metadata for customer controlled key value data that helps your own system connect Rangler resources to your internal records.

Metadata is for reconciliation only. Rangler does not use it for authorization, entitlements, billing decisions, webhook delivery, AI extraction, or public event quality.

Supported Shape

Metadata is a flat object.

Keys and values should be strings. Keep values small and avoid nested payloads.

{
  "metadata": {
    "internal_company_id": "co_94218",
    "watchlist_id": "wl_primary_equities"
  }
}

Good Uses

• store your internal company identifier on a watchlist entry
• store your internal workflow identifier on a webhook subscription
• store a reconciliation key for event-feed jobs
• store a non-sensitive environment marker such as sandbox_eval

Bad Uses

• do not store secrets or credentials
• do not store personal financial data
• do not store data needed for access control
• do not store large JSON payloads
• do not rely on metadata to change webhook delivery or event visibility

Python

No public SDK method accepts metadata yet.

metadata = {
    "watchlist_id": "wl_primary_equities",
    "owner_team": "research",
}

Do not send arbitrary metadata to endpoints that do not document it. Unsupported fields can be rejected or ignored.

Limits

Use metadata sparingly.

• maximum 50 keys
• maximum key length of 40 characters
• maximum value length of 500 characters
• keys must not contain square brackets