Options

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

All boolean options default to false if omitted. Integer options are optional.

Payload options

Option	Type	Default	Description
`decode_clarity_values`	boolean	`false`	Include human-readable Clarity values
`include_contract_abi`	boolean	`false`	Include contract ABI on deployments
`include_contract_source_code`	boolean	`false`	Include source code on deployments
`include_post_conditions`	boolean	`false`	Include post-conditions in metadata
`include_raw_transactions`	boolean	`false`	Include raw transaction hex
`include_block_metadata`	boolean	`false`	Include block metadata (Stacks & Bitcoin)
`include_block_signatures`	boolean	`false`	Include block signatures and signers
`enable_on_registration`	boolean	`false`	Enable chainhook immediately on creation
`expire_after_evaluations`	integer	none	Expire after N blocks evaluated
`expire_after_occurrences`	integer	none	Expire after N matches

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

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

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

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

Include the contract source code on deployment operations.

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

Include decoded post-conditions in transaction metadata.

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

Include raw transaction hex in transaction metadata.

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

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

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

Include signer information and signatures in block metadata.

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

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

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

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

Automatically expire the chainhook after evaluating this many blocks.

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

This chainhook will expire after evaluating 10,000 blocks.

Automatically expire the chainhook after this many matching occurrences.

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

This chainhook will expire after triggering 250 times.