Register an HTTPS webhook endpoint. The signing secret is shown exactly once.

POST 
/v1/account/:erd/webhooks

The URL must use https on port 443 and resolve to a public unicast address, which is checked again on every connection. Redirects are not followed. Any other URL gives WEBHOOK_URL_NOT_ALLOWED.

Request

Responses

201

Created, includes secret.

401

UNAUTHENTICATED, TOKEN_INVALID (details.expectedShard = 1 when the native-auth block hash is not a shard-1 block), TOKEN_EXPIRED, CHALLENGE_INVALID, API_KEY_INVALID, STREAM_TICKET_INVALID, ASSIGN_PROOF_REQUIRED, ASSIGN_PROOF_INVALID.

403

FORBIDDEN, ORIGIN_NOT_ALLOWED, API_KEY_SCOPE, ACCOUNT_SUSPENDED, LEASE_INVALID, RECEIVER_NOT_ALLOWED, SENDER_NOT_AUTHORIZED, DEPLOY_NOT_ALLOWED, FREE_FLOW_BARRED.

409

LEASE_MISMATCH, LEASE_EXPIRED, NONCE_PIN_MISMATCH, RESIGN_REQUIRED, RESIGN_SAME_NONCE, INTENT_ALREADY_EXECUTED, NOTHING_TO_CANCEL, NONCE_TOO_LOW, NONCE_IN_FLIGHT, NONCE_GAP, PRICE_ABOVE_MAX, QUEUED_BLOCK_EXISTS, DOWNGRADE_NOT_IMMEDIATE, PAYG_PRICE_ABOVE_MAX, QUOTE_EXPIRED, LIMIT_REACHED, IDEMPOTENCY_IN_PROGRESS, INTENT_ALREADY_SUBMITTED (logical idempotency key; carries the first intent), FREE_FLOW_BUSY.

422

REPLACEMENT_UNDERPRICED, RELAYER_UNKNOWN, RELAYER_SHARD_MISMATCH, GAS_PRICE_OUT_OF_RANGE, GAS_LIMIT_TOO_LOW, GAS_LIMIT_TOO_HIGH, GAS_OVERPROVISIONED, DATA_TOO_LARGE, SENDER_SIGNATURE_INVALID, GUARDIAN_*, INSUFFICIENT_SENDER_BALANCE, SIMULATION_FAILED, UNSUPPORTED_TX_FIELD, TIER_NOT_PURCHASABLE, DEPOSIT_BELOW_MIN, DEPOSIT_ABOVE_MAX, WEBHOOK_URL_NOT_ALLOWED, IDEMPOTENCY_KEY_REUSED.