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

# Create Webhook



## OpenAPI

````yaml certify-api/openapi.json POST /webhooks
openapi: 3.0.0
info:
  title: Xerobi Certification & Badge API
  version: '2026-01-01'
  description: >-
    A comprehensive API for issuing, managing, and verifying digital
    certificates and badges. Perfect for educational institutions, certification
    bodies, and organizations requiring verifiable credential management.
    Supports certificate templates, digital badges, credential lifecycle
    management, public verification, webhooks, and comprehensive audit logging.
  contact:
    name: Xerobi Support
    email: support@xerobi.com
  license:
    name: Proprietary
servers:
  - url: https://api.hixbe.com/certify
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Templates
    description: >-
      Certificate template management - create and manage reusable certificate
      designs
  - name: Credentials
    description: >-
      Issued credential management - view and track digital certificates and
      badges
  - name: Badges
    description: Digital badge definitions - create and manage badge metadata and criteria
  - name: Verification
    description: Public credential verification - validate issued certificates and badges
  - name: Issuance
    description: >-
      Credential issuance - create and distribute digital certificates and
      badges
  - name: Webhooks
    description: Event notifications - configure webhooks for credential lifecycle events
  - name: Audit Logs
    description: >-
      Activity tracking - comprehensive audit trail for all credential
      operations
  - name: Programs
    description: Certification programs - organize credentials into structured programs
  - name: Revocation
    description: Credential revocation - invalidate certificates and badges when necessary
paths:
  /webhooks:
    post:
      tags:
        - Webhooks
      summary: Create webhook endpoint
      description: >-
        Register a webhook endpoint to receive real-time notifications about
        credential events such as issuance, revocation, and verification
        attempts. Webhooks help you stay updated on credential lifecycle
        changes.
      operationId: createWebhook
      parameters:
        - $ref: '#/components/parameters/Xerobi-Version'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
            example:
              url: https://api.example.com/webhooks/hixbe
              events:
                - credential.issued
                - credential.revoked
                - credential.verified
      responses:
        '201':
          description: Webhook endpoint created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
              example:
                id: wh_1234567890abcdef
                url: https://api.example.com/webhooks/hixbe
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    Xerobi-Version:
      name: Xerobi-Version
      in: header
      required: true
      schema:
        type: string
        example: '2026-01-01'
      description: API version in YYYY-MM-DD format
  schemas:
    CreateWebhookRequest:
      type: object
      description: Request payload for creating a webhook endpoint
      required:
        - url
        - events
      properties:
        url:
          type: string
          format: uri
          description: HTTPS URL where webhook events will be sent
          example: https://api.example.com/webhooks/hixbe
        events:
          type: array
          description: Array of event types to subscribe to
          items:
            type: string
            enum:
              - credential.issued
              - credential.revoked
              - credential.verified
            example: credential.issued
          example:
            - credential.issued
            - credential.revoked
            - credential.verified
    WebhookResponse:
      type: object
      description: Response containing webhook endpoint information
      properties:
        id:
          type: string
          description: Unique identifier for the webhook endpoint
          example: wh_1234567890abcdef
        url:
          type: string
          description: URL where webhook events are sent
          example: https://api.example.com/webhooks/hixbe
    Error:
      type: object
      description: Standard error response format
      properties:
        error:
          type: string
          description: Error type identifier
          example: invalid_request
        message:
          type: string
          description: Human-readable error message
          example: The credential ID provided is invalid
        code:
          type: string
          description: Optional error code for programmatic handling
          example: INVALID_CREDENTIAL_ID
      required:
        - error
        - message
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

## Related topics

- [Webhooks](https://docs.xerobi.com/faq-guides/webhooks.md)
- [Create Webhook Endpoint](https://docs.xerobi.com/payment-api/endpoint/create-webhook-endpoint.md)
- [Register Webhook](https://docs.xerobi.com/sms-api/endpoint/register-webhook.md)
- [Delete webhook](https://docs.xerobi.com/sms-api/endpoint/delete-webhook.md)
- [List Webhooks](https://docs.xerobi.com/sms-api/endpoint/list-webhooks.md)


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