Create webhook

post

https://api.iofinnet.com/v1/webhooks

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"
  }
}

`operation.created`

Fired when a new operation is created against a vault.

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

`operation.updated`

Fired when an existing operation transitions to a new state.

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

`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"
  }
}

`wallet.transactionFailed`

Fired when a wallet transaction fails.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Webhook created

400Bad request