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

# Create a webhook

> Registers an endpoint to be told about the scopes given (see `GET /webhooks/scopes`): a POST of JSON over https, with the `headers` given (such as an `AuthKey` your platform issued) and the body `bodyTemplate` describes, or the standard body when it's left out. The answer includes the endpoint's signing secret, the only time it's shown. Send an `Idempotency-Key` header to make retries safe: a repeat with the same key returns the endpoint already made, with 200 instead of 201.



## OpenAPI

````yaml /api-reference/openapi.json post /webhooks
openapi: 3.1.1
info:
  title: Mojo Payments API
  description: >-
    Invoices, deposits, payments and locations for merchants; the merchant
    portfolio for reseller partners. Authenticate with an API key: exchange it
    at `POST /oauth/token` for a 10-minute access token, and send that as
    `Authorization: Bearer <token>`. Guides:
    https://kb.paymentsmojo.com/developers/overview
  version: '1'
servers:
  - url: https://api.paymentsmojo.com
security:
  - Bearer: []
tags:
  - name: Locations
  - name: Reseller portfolio
  - name: Invoice payments
  - name: Customers
  - name: Campaign pages
  - name: Authentication
  - name: Merchant accounts (MIDs)
  - name: Merchant applications
  - name: POS Gateway
  - name: Deposits
  - name: Card transactions
  - name: Recurring billing
  - name: Webhooks
paths:
  /webhooks:
    post:
      tags:
        - Webhooks
      summary: Create a webhook
      description: >-
        Registers an endpoint to be told about the scopes given (see `GET
        /webhooks/scopes`): a POST of JSON over https, with the `headers` given
        (such as an `AuthKey` your platform issued) and the body `bodyTemplate`
        describes, or the standard body when it's left out. The answer includes
        the endpoint's signing secret, the only time it's shown. Send an
        `Idempotency-Key` header to make retries safe: a repeat with the same
        key returns the endpoint already made, with 200 instead of 201.
      parameters:
        - name: Idempotency-Key
          in: header
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookEndpointInput'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedWebhookEndpoint'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedWebhookEndpoint'
        '401':
          description: >-
            No access token, or it expired or its key was revoked. Get a new
            token.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: >-
            The key doesn't have the permission this needs, or the organization
            is suspended.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: >-
            The request was understood but can't be done: `title` and `detail`
            say why.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too many requests. Wait and try again.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    WebhookEndpointInput:
      required:
        - name
        - url
        - enabled
        - scopes
        - headers
        - bodyTemplate
      type: object
      properties:
        name:
          type:
            - 'null'
            - string
        url:
          type:
            - 'null'
            - string
        enabled:
          type:
            - 'null'
            - boolean
        scopes:
          type:
            - 'null'
            - array
          items:
            type: string
        headers:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/WebhookHeaderInput'
        bodyTemplate:
          type:
            - 'null'
            - string
    CreatedWebhookEndpoint:
      required:
        - endpoint
        - signingSecret
      type: object
      properties:
        endpoint:
          $ref: '#/components/schemas/WebhookEndpointView'
        signingSecret:
          type: string
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
          description: A short summary, e.g. "Check the request".
        status:
          type: integer
          format: int32
        detail:
          type: string
          description: What to change, in plain words.
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Field validation messages, by field (400 only).
      description: What went wrong (RFC 9457).
    WebhookHeaderInput:
      required:
        - name
        - value
      type: object
      properties:
        name:
          type:
            - 'null'
            - string
        value:
          type:
            - 'null'
            - string
        secret:
          type:
            - 'null'
            - boolean
    WebhookEndpointView:
      required:
        - id
        - name
        - url
        - enabled
        - scopes
        - headers
        - bodyTemplate
        - standardBody
        - createdAt
        - createdByName
        - updatedAt
        - updatedByName
        - lastSentAt
        - waiting
        - failedThisWeek
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        url:
          type: string
        enabled:
          type: boolean
        scopes:
          type: array
          items:
            type: string
        headers:
          type: array
          items:
            $ref: '#/components/schemas/WebhookHeaderView'
        bodyTemplate:
          type: string
        standardBody:
          type: boolean
        createdAt:
          type: string
          format: date-time
        createdByName:
          type: string
        updatedAt:
          type:
            - 'null'
            - string
          format: date-time
        updatedByName:
          type:
            - 'null'
            - string
        lastSentAt:
          type:
            - 'null'
            - string
          format: date-time
        waiting:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        failedThisWeek:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        createdByApiKeyId:
          type:
            - 'null'
            - string
          format: uuid
        createdByApiKeyRevokedAt:
          type:
            - 'null'
            - string
          format: date-time
    WebhookHeaderView:
      required:
        - name
        - value
        - valueLast4
        - secret
      type: object
      properties:
        name:
          type: string
        value:
          type:
            - 'null'
            - string
        valueLast4:
          type:
            - 'null'
            - string
        secret:
          type: boolean
  securitySchemes:
    Bearer:
      type: http
      description: >-
        An access token from POST /oauth/token (your API key's id and secret).
        It lasts 10 minutes.
      scheme: bearer
      bearerFormat: JWT

````

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