Webhook

The Subgraph Webhook is an innovative feature on our platform that allows you to subscribe to specific entities within a subgraph. This functionality ensures you receive data in real-time, directly to your system, whenever any data related to your subscribed entities is added or modified.

When you create a webhook, data will be sent to the URL you provide.

To correctly process incoming webhook data, ensure your URL is properly configured. For detailed guidance on managing incoming webhook data, please refer to the Handling Incoming Webhook Data section.

This section will guide you on how to manage your webhooks.

• Enable Webhook

• Create Webhook

• Webhook Details

• Update Webhook

• Undelivered Records

• Delete Webhook

• Disable Webhook

Webhook Guide

Step 1: Register/Login - Create a new account or log in to your existing account on the Zeeve Platform.

Step 2: Navigate to Hosted Subgraphs - Click on the Hosted Subgraphs above the TRACEYE section on the Left navigation panel.

Step 3: You will be redirected to the Subgraph Dashboard screen to view a list of all existing subgraphs.

Step 4: Select a subgraph to navigate to its details page, then click on the Webhooks tab. This section displays all your configured webhooks.

---

Enable Webhook

Webhook activation is only possible for deployed subgraphs.

To enable webhook usage for a specific subgraph, follow these steps:

1. Click the Enable Webhook button, a modal window will appear.

2. In the modal, click the Enable button to activate webhook functionality, or click Close button to dismiss the modal without making changes.

If it's not enabled, verify the availability of Purchased Webhook Add-ons by visiting the Subscriptions page within your account.

For additional webhook addons, please visit our Purchase Subscription page.

After enabling the webhook for that subgraph, you can now manage your webhooks.

---

Create Webhook

To create webhook for a specific subgraph, follow these steps:

1. Click on the Create Webhook button.

2. In the model that opens, select the entities.

3. Enter the URL in the designated field.

4. Click on the Continue button to proceed, or click Cancel button to dismiss the modal.

Upon successful authentication, a new webhook will be created.

---

Webhook Details

Selecting a webhook will open a modal displaying the following details:

• Entity: The name of the entity for which the webhook is created.

• URL: The specified URL that handles incoming webhook data.

• Status: The current status of the webhook, which can be either Active or Paused.

• Delivered Records: The total number of data records received by the URL.

• ID: The unique identifier assigned to a webhook.

• Created At: The timestamp marking the creation of the webhook.

---

Update Webhook

To modify webhook, follow these steps:

1. Click on the desired webhook to open a modal displaying its information.

2. Click on the Update icon to enable URL editing.

3. Update the URL as necessary.

4. Click on the Save Changes button to apply the modifications, or click Cancel button to dismiss the modal.

---

Undelivered Records

On the subgraph detail page, navigate to the Webhooks section. Then, click any webhook row to check for undelivered records.

On the window that appears, navigate to the Undelivered Records section.

In case, there are no undelivered records, the following message will be displayed.

If undelivered records are present then you can access them and try again to get them delivered by clicking on the Try Again button.

---

Delete Webhook

To delete webhook, follow these steps:

1. Click on the desired webhook to open a modal displaying its information.

2. Click on the Delete icon to open a confirmation modal.

3. Click Continue button to delete the webhook, or click Close button to dismiss the modal.

---

Disable Webhook

When there are more than one webhook

To delete all webhooks and disable webhook use for a specific subgraph, follow these steps:

1. Locate the ENTITY column and click the checkbox adjacent to it. This action selects all the webhooks.

2. Navigate to the right side of the Create Webhook button and click the Delete button to open a confirmation modal.

3. Click Yes button to remove all webhooks and disable webhook use for that subgraph, or click No button to dismiss the modal.

When there are no webhook

To disable webhook use for a specific subgraph, follow these steps:

1. Navigate to the right side of the Create Webhook button and click the Disable Webhook button to open a confirmation modal.

2. Click Yes button to disable webhook use for that subgraph, or click No button to dismiss the modal.

---

Handle Incoming Webhook Data

When configuring a webhook, it is imperative that the URL specified is capable of handling POST requests.

API Request Retry Policy

When initiating a request to a specified URL, the system will automatically attempt to connect up to three times at 30-minute intervals. The following outlines the deduction of API units based on these attempts:

• Initial Request: Upon the first connection attempt, 45 API units will be deducted.

• Subsequent Tries: For each of the two additional attempts (if necessary), 22.5 API units will be deducted.

If, after three attempts, the URL remains unreachable, the data will be classified as an undelivered record.

Refer this section to process Undelivered Records.

Sample data payload that will be sent to the provided URL.

{
  "data": [
    {
      "id": "\\x1af00600",
      "vid": 50,
      "hour": 454682,
      "block$": 56200,
      "protocol": "\\x4200000000000000000000000000000000000010",
      "timestamp": 1636856051,
      "block_number": 56200,
      "cumulative_transaction_count": 1621,
      "cumulative_transfer_in_count": 1440,
      ...
    },
    {
      ...
    },
    {
      ...
    }
  ]
}