---
updatedAt: 2026-07-03T01:53:36.000Z
agentTools:
  projectIndex: https://x-series-api.lightspeedhq.com/llms.txt
---

# Get Webhook

Fetch a single webhook by its ID.

🔒 Requires: `webhooks` scope

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "contact": {
      "email": "x-series.api@lightspeedhq.com",
      "name": "Lightspeed Developer Relations",
      "url": "https://developers.retail.lightspeed.app"
    },
    "description": "Lightspeed Retail (X-Series) API.",
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "termsOfService": "https://developers.lightspeedhq.com/terms",
    "title": "API 2026-07",
    "version": "2026-07"
  },
  "servers": [
    {
      "url": "https://{domain_prefix}.retail.lightspeed.app/api/2026-07",
      "variables": {
        "domain_prefix": {
          "default": "example",
          "description": "Domain prefix of the store to be operated on"
        }
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "externalDocs": {
    "description": "List of tz database time zones",
    "url": "https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"
  },
  "tags": [
    {
      "description": "Webhook operations",
      "name": "Webhooks"
    }
  ],
  "paths": {
    "/webhooks/{webhookId}": {
      "get": {
        "description": "Fetch a single webhook by its ID.\n\n🔒 Requires: `webhooks` scope",
        "operationId": "get-webhooks-id",
        "parameters": [
          {
            "in": "path",
            "name": "webhookId",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Webhook"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "OK"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "Not Found"
          }
        },
        "summary": "Get Webhook",
        "tags": [
          "Webhooks"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Webhook": {
        "description": "The configuration for a webhook.",
        "properties": {
          "active": {
            "description": "Whether this webhook is enabled or not",
            "type": "boolean"
          },
          "id": {
            "description": "The ID of this webhook",
            "type": "string"
          },
          "retailer_id": {
            "description": "The ID of the retailer this webhook belongs to",
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/WebhookType"
          },
          "url": {
            "description": "The URL to send this webhook to",
            "type": "string"
          }
        },
        "title": "Webhook",
        "type": "object",
        "x-examples": {}
      },
      "WebhookType": {
        "description": "The webhook type. These can be one of:\n- sale.update\n- product.update\n- customer.update\n- inventory.update\n- register_closure.create\n- consignment.send\n- consignment.receive\n",
        "enum": [
          "sale.update",
          "product.update",
          "customer.update",
          "inventory.update",
          "register_closure.create",
          "consignment.send",
          "consignment.receive"
        ],
        "title": "WebhookType",
        "type": "string",
        "x-examples": {
          "example-1": "sale.update"
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "description": "Bearer Token for API authentication.",
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```