channels

Delete a webhook channel

Deletes one of the box's webhook channels. Nothing more is delivered to it.

  • Cost: Free. Signed by the box's agent over method DELETE, path /agent/v1/<address lowercased>/webhook/<id> and no body (the hash of no bytes). Or send an ARCGATE-KEY of the account the box is linked to, with no signature. Another account's key, or any key for a box that is not linked, does not apply to the box: the call is checked as if no key were sent, so it needs the signature. A key nobody holds is a 401 key_invalid. The key keeps working after the account has lapsed (its grace has ended).
  • Inputs: address and id (path).
  • Returns: deleted and the id. Messages stay in the box. The price of the channel is not refunded.
  • Errors:
    • 404 webhook_not_found: the box has no webhook channel with that id. It was never made, was already deleted, or is another box's.
  • Next:
    • webhookCreate: make a new channel (paid).
delete/agent/v1/{address}/webhook/{id}

Request

  • Base URL: https://api.arcgate.dev
  • URL: https://api.arcgate.dev/agent/v1/{address}/webhook/{id}
  • Auth: none required

Path parameters

addressstring required

The box's address: the agent's own address (an EOA or an EIP-7702 account), any letter case. The box is keyed by it, and a signed request must be signed by it.

idstring required

The webhook channel's id: 22 base64url characters, as the create or the list returned it.

Headers

ARCGATE-KEYstring

A key of the account the box is linked to, in place of the three signature headers, which are then not needed. Another account's key, or any key for a box that is not linked, does not apply to the box: the call is checked as if no key were sent, so it needs the box's signature. A key nobody holds is a 401 key_invalid. The key keeps working after the account has lapsed (its grace has ended).

AGENT-SIGNATUREstring

Not needed when an ARCGATE-KEY of the account the box is linked to is sent instead. The EIP-712 signature (0x hex) over the AgentRequest typed data (the AccountRequest typed data on /account/v1, which also begins with origin, the API's base URL with no trailing slash): the box's address (the owner's on /account/v1), this request's method and path with every parameter filled in (the address lowercased), the keccak256 of its canonical-JSON body (of no bytes when there is none), the nonce and the expiry. Domain {name: "arcgate", version: "1"}, no chainId; a wallet that can only sign with one (such as Circle's) may add the chainId of the chain this deployment serves (5042 on Arc mainnet), and no other. A missing header is a 401 signature_required.

AGENT-NONCEstring

Not needed when an ARCGATE-KEY of the account the box is linked to is sent instead. A fresh random 32-byte value (0x hex), the signed nonce. Each is accepted once per box (per owner on /account/v1): a repeat is a 401 nonce_reused.

AGENT-EXPIRYinteger

Not needed when an ARCGATE-KEY of the account the box is linked to is sent instead. The signed expiry, unix seconds: in the future, and no further ahead than 300 seconds from now. Otherwise 401 signature_expired.

Response

The webhook channel is deleted.

deletedtrue required

The channel is gone and nothing more is delivered to it. Messages stay in the box.

idstring required

The webhook channel's id: 22 base64url characters, as the create or the list returned it.

Changes

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