Webhooks

Introduction

The webhook functionality in our application allows users to receive real-time updates on their user operations (userOps) via their own API endpoints. When a user creates a webhook, they provide their API URL where our system will send status updates once the userOp is successfully executed on the blockchain.

Detailed instructions for creating a webhook and integrating it into your system are provided below.

Integration

Creating Webhook

The following steps outline how to create a webhook:

1. Login to Byzanlink dashboard

2. Go to the Webhooks page under the Services section in the side menu, then click on Create Webhook.

1. Provide the inputs for all the fields and click Save

1. Once the webhook is created, you will be redirected to All Webhooks screen.

1. Click the Play button under Action column next to a specific table row to verify the API endpoint provided in the Webhook URL. If successful, you’ll see the message Webhook tested successfully!. If the test fails, the message Webhook Fetch Failed will appear, and you’ll need to provide a valid URL.

2. Edit and Delete functionality are also available under Action column

Handling Webhook Response

Once a user operation is submitted, the webhook monitors for updates. After the user operation is successfully executed, the API URL provided in the webhook will receive a response containing the userOp hash (transactionHash) and the transaction receipt object (transactionReceipt). In case of a failure or cancellation, the response will include a message key detailing the reason for the failure or cancellation.

Success

{
  transactionHash: "0xda1b935147b1ad8e15612cd72fb74859ae26bcf04e0a9863f4dcb7b2554dd81b", //user op hash,
  transactionReceipt:
  {
    transactionHash: "",
    transactionReceipt: {
      userOpHash: '0xda1b935147b1ad8e15612cd72fb74859ae26bcf04e0a9863f4dcb7b2554dd81b',
      sender: '0x3aa9250735eE7d2A20Ca98d27eE4bbA6a40033A7',
      nonce: '0x1',
      actualGasCost: '0x16bc1a91ba1f20',
      actualGasUsed: '0x20775',
      success: true,
      logs: [
        XXXX
      ],
      receipt: {
        to: '0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789',
        from: '0x0266c5192fF26CDA6697e0F86Bd42c002Ee68C8E',
        contractAddress: null,
        transactionIndex: '0x0',
        gasUsed: '0x1ff16',
        logsBloom: '0x00000000000000001000000000000000000800000000000000000000000000000008000220000000400200110000000000108000000000000000020000402008000000000000000000000800000000800000000000000000000101001000000000000000080000000000000000000000000004000000004080820000000000000000000000000000000000000000000000000000000000000000000000000000200000010040800000480000020000000000000000000000000002000000004000000000000000000001000000000000000000000008800000108000000000000000000000000001000000100041008000000000000010000000080000100000',
        blockHash: '0x5c82392dd86498667696cc6a9ea593e41af1810053361359e9485ba45e8ee4ee',
        transactionHash: '0x4e5a78156894ca97ca762954f320767a90f91ae3694b720dee6d33e4827f4939',
        logs: [
          XXXX
        ],
        blockNumber: '0xc8b98f',
        confirmations: '0x261',
        cumulativeGasUsed: '0x1ff16',
        effectiveGasPrice: '0xb3446dea0',
        status: '0x1',
        type: '0x2',
        byzantium: true
      }
    }
  }
}

Failure

{
    "transactionHash": "" //user op hash,
    "message" : "" // Reason for failure or cancellation
}