Account

Register an index-move webhook — Intelligence plan

Register an HTTPS endpoint to receive a POST when any tracked index moves beyond a threshold.

Intelligence plan required. Maximum 10 active webhooks per account.

Payload (sent to your endpoint): {category_id, index_value, change_pct, direction, threshold_pct, as_of, source}

Signature verification: Each delivery includes X-OPN-Signature: sha256=<hmac>. Verify with HMAC-SHA256(secret, raw_body_bytes).

post/account/webhooks

Request

  • Base URL: https://opnplatform.com/api
  • URL: https://opnplatform.com/api/account/webhooks
  • Auth: HTTP bearer

Request body

endpoint_urlstring uri required

HTTPS URL to POST to

index_codesstring[] nullable

Index codes to watch. null = all indices

threshold_pctnumber

Fire when abs(change_pct) >= this

Response

Webhook registered — secret shown once

endpoint_urlstring
idinteger
index_codesunknown
secretstring

HMAC signing secret — store securely, shown once only

threshold_pctnumber

Changes

No recorded changes to this operation across all 1 revision of this API.