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

# Register a webhook

> Register an HTTPS endpoint to receive signed order-event deliveries. The response includes the signing secret — it is shown only this once.



## OpenAPI

````yaml /openapi/openapi-provider.json post /provider/webhooks
openapi: 3.0.0
info:
  title: OfferGrid API
  description: >-
    **Provider API** - Create and manage service offerings, fulfill orders from
    resellers.


    As a provider, you can:

    - Create and publish service offerings (internet, electricity)

    - Control which resellers can access your offers (all, preferred, or
    selected)

    - View and manage orders from resellers

    - Update order fulfillment status and schedule installations

    - Track order lifecycle from pending to completion
  version: '1.0'
  contact: {}
servers:
  - url: https://api.offergrid.io
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: provider-offers
    description: 'Provider: Manage your service offerings'
  - name: provider-orders
    description: 'Provider: Fulfill orders from resellers'
paths:
  /provider/webhooks:
    post:
      tags:
        - provider-webhooks
      summary: Register a webhook
      description: >-
        Register an HTTPS endpoint to receive signed order-event deliveries. The
        response includes the signing secret — it is shown only this once.
      operationId: ProviderWebhooksController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookDto'
      responses:
        '201':
          description: ''
      security:
        - api-key: []
components:
  schemas:
    CreateWebhookDto:
      type: object
      properties:
        url:
          type: string
          description: HTTPS endpoint that will receive signed order-event deliveries
          example: https://provider-system.example.com/offergrid-callback
        events:
          type: array
          description: Event types this webhook subscribes to
          example:
            - order.item.created
            - order.item.status_changed
          items:
            type: string
            enum:
              - order.created
              - order.item.created
              - order.item.status_changed
              - order.cancelled
      required:
        - url
        - events
      title: Create Webhook
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Team API key for authentication. Your team role
        (provider/reseller/hybrid) determines which endpoints you can access.

````