> ## Documentation Index
> Fetch the complete documentation index at: https://docs.limitguard.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Register Webhook

> Register a new webhook endpoint. URL must use HTTPS.

Returns the signing secret ONE TIME: store it securely.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/webhooks
openapi: 3.1.0
info:
  title: Limitguard.ai
  description: >-
    Lead validation API: the company behind each lead checked against the NL and
    BE business registers, EU VAT and sanctions lists, plus company, KYB and
    agent wallet checks for developers and AI agents
  version: 0.1.0
servers:
  - url: https://api.limitguard.ai
security: []
paths:
  /v1/webhooks:
    post:
      summary: Register Webhook
      description: |-
        Register a new webhook endpoint. URL must use HTTPS.

        Returns the signing secret ONE TIME: store it securely.
      operationId: register_webhook_v1_webhooks_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreateRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookCreateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    WebhookCreateRequest:
      properties:
        url:
          type: string
          maxLength: 2048
          minLength: 1
          title: Url
          description: HTTPS callback URL
        events:
          items:
            $ref: '#/components/schemas/WebhookEventType'
          type: array
          minItems: 1
          title: Events
          description: Event types to subscribe to
      type: object
      required:
        - url
        - events
      title: WebhookCreateRequest
    WebhookCreateResponse:
      properties:
        id:
          type: string
          title: Id
        url:
          type: string
          title: Url
        events:
          items:
            $ref: '#/components/schemas/WebhookEventType'
          type: array
          title: Events
        secret:
          type: string
          title: Secret
        active:
          type: boolean
          title: Active
        created_at:
          type: string
          format: date-time
          title: Created At
        delivered_events:
          items:
            $ref: '#/components/schemas/WebhookEventType'
          type: array
          title: Delivered Events
          description: >-
            Subset of `events` actually sent today; the rest are registrable but
            not yet emitted by anything
      type: object
      required:
        - id
        - url
        - events
        - secret
        - active
        - created_at
        - delivered_events
      title: WebhookCreateResponse
      description: Response for POST /v1/webhooks -- includes secret (one-time display).
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WebhookEventType:
      type: string
      enum:
        - trust.score.changed
        - sanctions.match.new
        - trust.level.downgrade
        - certificate.expired
        - identifier.change.new
      title: WebhookEventType
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.