Options Reference

Options control payload enrichment and evaluation windows for your chainhook. The options field is optional and can be omitted or set to null.

Payload Enrichment Options

decode_clarity_values

Include human-readable repr (and inferred types) alongside hex for arguments, logs, and results.

• Type: boolean
• Default: false

{
  "options": {
    "decode_clarity_values": true
  }
}

Example output when enabled:

{
  "hex": "0x01000000000000000000000002690ed9fe",
  "repr": "u10352515582",
  "type": "uint"
}

include_contract_abi

Include the contract ABI on deployment operations. This improves argument typing when decoding.

• Type: boolean
• Default: false

{
  "options": {
    "include_contract_abi": true
  }
}

include_contract_source_code

Include the contract source code on deployment operations.

• Type: boolean
• Default: false

{
  "options": {
    "include_contract_source_code": true
  }
}

include_post_conditions

Include decoded post-conditions in transaction metadata.

• Type: boolean
• Default: false

{
  "options": {
    "include_post_conditions": true
  }
}

include_raw_transactions

Include raw transaction hex in transaction metadata.

• Type: boolean
• Default: false

{
  "options": {
    "include_raw_transactions": true
  }
}

include_block_metadata

Include block metadata for both Stacks and Bitcoin blocks, with execution costs, transaction count, etc.

• Type: boolean
• Default: false

{
  "options": {
    "include_block_metadata": true
  }
}

include_block_signatures

Include signer information and signatures in block metadata.

• Type: boolean
• Default: false

{
  "options": {
    "include_block_signatures": true
  }
}

Activation Options

enable_on_registration

Enable the chainhook immediately upon registration/creation. By default, a new chainhook is disabled upon creation.

• Type: boolean
• Default: false

{
  "options": {
    "enable_on_registration": true
  }
}

When set to true, the response will include status.enabled = true and the chainhook will start processing events immediately.

Expiration Options

expire_after_evaluations

Automatically expire the chainhook after evaluating this many blocks.

• Type: integer
• Default: None (no expiration)

{
  "options": {
    "expire_after_evaluations": 10000
  }
}

This chainhook will expire after evaluating 10,000 blocks.

expire_after_occurrences

Automatically expire the chainhook after this many matching occurrences.

• Type: integer
• Default: None (no expiration)

{
  "options": {
    "expire_after_occurrences": 250
  }
}

This chainhook will expire after triggering 250 times.

Combined Examples

Development Setup

For local development with maximum visibility:

{
  "options": {
    "decode_clarity_values": true,
    "include_contract_abi": true,
    "include_contract_source_code": true,
    "include_post_conditions": true,
    "include_block_metadata": true,
    "enable_on_registration": true
  }
}

Production Setup

For production with essential data only:

{
  "options": {
    "decode_clarity_values": true,
    "enable_on_registration": true
  }
}

Time-Limited Chainhook

For a chainhook that auto-expires after 1000 blocks or 100 matches:

{
  "options": {
    "decode_clarity_values": true,
    "enable_on_registration": true,
    "expire_after_evaluations": 1000,
    "expire_after_occurrences": 100
  }
}

The chainhook will expire when either condition is met.

Options Summary Table

Next Steps