Create webhook

Create a webhook subscription.

When a subscribed event fires, the configured URL receives a POST request with a JSON body of the shape { "eventType": "<event>", "eventMetadata": { ... } }. The fields available on eventMetadata depend on the event type, as documented below.

Supported event types

vault.created

Fired when a new vault is created in a workspace.

{
  "eventType": "vault.created",
  "eventMetadata": {
    "vaultId": "cln4xy7q90001abc123def456"
  }
}

vault.archived

Fired when a vault is archived.

{
  "eventType": "vault.archived",
  "eventMetadata": {
    "vaultId": "cln4xy7q90001abc123def456"
  }
}

vault.unarchived

Fired when a previously archived vault is restored.

{
  "eventType": "vault.unarchived",
  "eventMetadata": {
    "vaultId": "cln4xy7q90001abc123def456"
  }
}

operation.created

Fired when a new operation is created against a vault. This event is emitted only at initial creation.

Types: RESHARE, SIGN

Statuses: VOTING

{
  "eventType": "operation.created",
  "eventMetadata": {
    "operationId": "op_01HX7Z8K9PQRSTUVWXYZ12345",
    "vaultId": "cln4xy7q90001abc123def456",
    "type": "SIGN",
    "status": "VOTING"
  }
}

operation.updated

Fired when an existing operation transitions to a new state. status reflects the operation lifecycle (for example, COMPLETED once signing has finished).

Types: RESHARE, SIGN

Statuses: SIGNING, COMPLETED, REJECTED, CANCELLED, FAILED, EXPIRED

Sub-statuses: BROADCAST, MINED, FAILED

Optional subStatus in eventMetadata describes post-signature follow-on work while status remains COMPLETED—for example broadcasting the signed transaction (BROADCAST), on-chain confirmation once mined (MINED), or a failure during that flow (FAILED). Omitted when there is no active sub-step.

{
  "eventType": "operation.updated",
  "eventMetadata": {
    "operationId": "op_01HX7Z8K9PQRSTUVWXYZ12345",
    "vaultId": "cln4xy7q90001abc123def456",
    "type": "SIGN",
    "status": "COMPLETED",
    "subStatus": "BROADCAST"
  }
}

wallet.walletInteraction

Fired for wallet-level interactions.

{
  "eventType": "wallet.walletInteraction",
  "eventMetadata": {
    "chain": "ethereum",
    "address": "0xA1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D6E7F8A9B0",
    "vaultId": "cln4xy7q90001abc123def456",
    "transactionHash": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "workspaceId": "cln4ws8r10002def456ghi789"
  }
}

wallet.receiveToken

Fired when a wallet receives a token.

{
  "eventType": "wallet.receiveToken",
  "eventMetadata": {
    "chain": "ethereum",
    "address": "0xA1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D6E7F8A9B0",
    "vaultId": "cln4xy7q90001abc123def456",
    "transactionHash": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "workspaceId": "cln4ws8r10002def456ghi789",
    "amount": "0.5",
    "asset": "ETH",
    "fromAddress": "0x44Dc0509B73A8b8051F563434715453f004229e5",
    "toAddress": "0xA1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D6E7F8A9B0"
  }
}

wallet.sendToken

Fired when a wallet sends a token.

{
  "eventType": "wallet.sendToken",
  "eventMetadata": {
    "chain": "ethereum",
    "address": "0xA1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D6E7F8A9B0",
    "vaultId": "cln4xy7q90001abc123def456",
    "transactionHash": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "workspaceId": "cln4ws8r10002def456ghi789",
    "amount": "0.5",
    "asset": "ETH",
    "fromAddress": "0xA1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D6E7F8A9B0",
    "toAddress": "0x7136FB945B868447C8281fB22932c74d175758A3",
    "operationId": "op_01HX7Z8K9PQRSTUVWXYZ12345"
  }
}

wallet.transactionFailed

Fired when a wallet transaction fails.

{
  "eventType": "wallet.transactionFailed",
  "eventMetadata": {
    "chain": "ethereum",
    "address": "0xA1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D6E7F8A9B0",
    "vaultId": "cln4xy7q90001abc123def456",
    "transactionHash": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "workspaceId": "cln4ws8r10002def456ghi789"
  }
}

wallet.created

Fired when a new wallet address is created within a vault.

{
  "eventType": "wallet.created",
  "eventMetadata": {
    "vaultId": "cln4xy7q90001abc123def456",
    "address": "0xA1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D6E7F8A9B0",
    "chain": "ethereum",
    "ecosystem": "evm",
    "derivationPath": "m/44'/60'/0'/0/0"
  }
}

wallet.monitored

Fired when a wallet address starts being monitored.

{
  "eventType": "wallet.monitored",
  "eventMetadata": {
    "vaultId": "cln4xy7q90001abc123def456",
    "address": "0xA1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D6E7F8A9B0",
    "chain": "ethereum",
    "ecosystem": "evm",
    "derivationPath": "m/44'/60'/0'/0/0"
  }
}

wallet.unmonitored

Fired when a wallet address stops being monitored.

{
  "eventType": "wallet.unmonitored",
  "eventMetadata": {
    "vaultId": "cln4xy7q90001abc123def456",
    "address": "0xA1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D6E7F8A9B0",
    "chain": "ethereum",
    "ecosystem": "evm",
    "derivationPath": "m/44'/60'/0'/0/0"
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
events
array of strings
required
events*
string
required
uri
required
authentication
required
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json