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

# Create a webhook endpoint

> The response includes `secret` exactly once; it is stored encrypted and never returned again. Requires `webhooks:write`.



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/webhooks
openapi: 3.1.0
info:
  title: Sendbaze API
  version: '1.0'
  description: >
    Transactional email and SMS for Africa. Send from your own domain through
    Amazon SES in Cape Town.

    Every send returns an id immediately; delivery is reported by webhook and in
    the dashboard logs.
  contact:
    name: Sendbaze support
    email: support@sendbaze.com
    url: https://www.sendbaze.com
servers:
  - url: https://api.sendbaze.com
security:
  - bearerAuth: []
tags:
  - name: Emails
  - name: Templates
  - name: Domains
  - name: Suppressions
  - name: Webhooks
  - name: SMS
  - name: Usage
paths:
  /v1/webhooks:
    post:
      tags:
        - Webhooks
      summary: Create a webhook endpoint
      description: >-
        The response includes `secret` exactly once; it is stored encrypted and
        never returned again. Requires `webhooks:write`.
      operationId: createWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
            example:
              url: https://api.yourshop.co.za/webhooks/sendbaze
              description: Production CRM sync
              events:
                - email.bounced
                - email.complained
                - email.unsubscribed
      responses:
        '201':
          description: Created, with the signing secret
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedWebhookEndpoint'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '422':
          $ref: '#/components/responses/Unprocessable'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    CreateWebhookRequest:
      type: object
      required:
        - url
      properties:
        url:
          type: string
          format: uri
          description: >-
            https URL that answers 2xx within 10 seconds. Private and local
            addresses are refused.
        description:
          type: string
          maxLength: 200
        events:
          type: array
          description: Omit or send [] for every event.
          items:
            $ref: '#/components/schemas/WebhookEventType'
    CreatedWebhookEndpoint:
      allOf:
        - $ref: '#/components/schemas/WebhookEndpoint'
        - type: object
          required:
            - secret
          properties:
            secret:
              type: string
              description: Shown once. Verify signatures with it.
    WebhookEventType:
      type: string
      enum:
        - email.sent
        - email.delivered
        - email.bounced
        - email.complained
        - email.failed
        - email.unsubscribed
        - sms.sent
        - sms.delivered
        - sms.failed
        - sms.opted_out
        - usage.threshold
        - credits.low
        - billing.payment_failed
    WebhookEndpoint:
      type: object
      required:
        - id
        - url
        - description
        - events
        - enabled
        - disabledReason
        - secretPrefix
        - failingSince
        - lastSuccessAt
        - lastFailureAt
        - createdAt
      properties:
        id:
          type: string
          example: whk_01j9x7k2r4m8q3v5n6b7c8d9e0
        url:
          type: string
        description:
          type:
            - string
            - 'null'
        events:
          type: array
          items:
            type: string
          description: Empty means every event.
        enabled:
          type: boolean
        disabledReason:
          type:
            - string
            - 'null'
        secretPrefix:
          type: string
          example: whsec_a1b2c3
        failingSince:
          type:
            - string
            - 'null'
          format: date-time
        lastSuccessAt:
          type:
            - string
            - 'null'
          format: date-time
        lastFailureAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
    ErrorBody:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Stable error code; see the errors reference.
          example: validation_error
        message:
          type: string
        docs:
          type: string
          format: uri
        fields:
          type: object
          description: Present on validation errors. Dotted path to messages.
          additionalProperties:
            type: array
            items:
              type: string
        limit:
          type: integer
          description: On `plan_limit`, the ceiling that was reached.
        upgradeUrl:
          type: string
          format: uri
          description: >-
            Where to change plan, when a bigger plan would have allowed the
            request.
        topUpUrl:
          type: string
          format: uri
          description: >-
            Where to add wallet funds, when a balance would have allowed the
            request.
        settingsUrl:
          type: string
          format: uri
          description: >-
            Where to change an organisation setting that blocked the request
            (SMS destinations).
        domainsUrl:
          type: string
          format: uri
          description: >-
            Where to add and verify a sending domain, on
            `sandbox_recipient_not_allowed` and `sandbox_limit_reached`.
  responses:
    PaymentRequired:
      description: Allowance used up, not enough credits, or plan limit reached
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unprocessable:
      description: >-
        Validation failed, a recipient is suppressed, or an SMS destination is
        not supported (destination_not_supported)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: validation_error
              message: The request has invalid fields.
              docs: https://docs.sendbaze.com/errors#validation_error
              fields:
                to.1:
                  - must be a valid email address
    ServiceUnavailable:
      description: A dependency is unavailable; nothing was changed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from the dashboard. `sk_live_…` sends; `sk_test_…` validates
        and returns ids without sending.

````

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