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

# Criar um webhook

> Cria um novo webhook para receber notificações automáticas de eventos da sua loja.

O `endpoint` deve ser uma URL HTTPS válida e não pode apontar para endereços locais ou IPs privados.

**Alternativa**: Você também pode criar e gerenciar seus webhooks pelo [Dashboard da AbacatePay](https://app.abacatepay.com/webhooks).


<Card horizontal>
  Requer a permissão `WEBHOOK:CREATE`.
</Card>


## OpenAPI

````yaml POST /webhooks/create
openapi: 3.1.0
info:
  title: API AbacatePay
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
  - url: https://api.abacatepay.com/v2
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /webhooks/create:
    post:
      summary: Criar um webhook
      description: >
        Cria um novo webhook para receber notificações automáticas de eventos da
        sua loja.


        O `endpoint` deve ser uma URL HTTPS válida e não pode apontar para
        endereços locais ou IPs privados.


        **Alternativa**: Você também pode criar e gerenciar seus webhooks pelo
        [Dashboard da AbacatePay](https://app.abacatepay.com/webhooks).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreateInput'
      responses:
        '200':
          description: Webhook criado com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WebhookResponse'
                  error:
                    type: string
                    nullable: true
                    example: null
                  success:
                    $ref: '#/components/schemas/Success'
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: >-
                      Mensagem de erro descrevendo o motivo da falha na
                      autenticação.
                    example: Token de autenticação inválido ou ausente.
      security:
        - bearerAuth: []
components:
  schemas:
    WebhookCreateInput:
      type: object
      description: Dados para criação de um webhook.
      required:
        - name
        - endpoint
        - secret
        - events
      additionalProperties: false
      properties:
        name:
          type: string
          description: Nome identificador do webhook
          example: Webhook de Pagamentos
        endpoint:
          type: string
          description: URL HTTPS que receberá as notificações de eventos
          example: https://meusite.com/webhooks/abacatepay
        secret:
          type: string
          description: Sua chave usada para autenticar nosso webhook
          example: meu-secret-seguro
        events:
          type: array
          description: Lista de eventos que este webhook deve receber
          items:
            type: string
            enum:
              - checkout.completed
              - checkout.refunded
              - checkout.disputed
              - checkout.lost
              - transparent.completed
              - transparent.refunded
              - transparent.disputed
              - transparent.lost
              - subscription.completed
              - subscription.trial_started
              - subscription.cancelled
              - subscription.renewed
              - payout.completed
              - payout.failed
              - transfer.completed
              - transfer.failed
          example:
            - checkout.completed
            - subscription.renewed
    WebhookResponse:
      type: object
      description: Os dados do webhook.
      required:
        - id
        - name
        - endpoint
        - events
        - devMode
        - v2
        - createdAt
        - updatedAt
      additionalProperties: false
      properties:
        id:
          type: string
          description: Identificador único do webhook
          example: webh_abc123xyz
        name:
          type: string
          description: Nome identificador do webhook
          example: Webhook de Pagamentos
        endpoint:
          type: string
          description: URL HTTPS que recebe as notificações de eventos
          example: https://meusite.com/webhooks/abacatepay
        events:
          type: array
          description: Lista de eventos subscritos
          items:
            type: string
          example:
            - checkout.completed
            - subscription.renewed
        devMode:
          type: boolean
          description: Indica se o webhook foi criado em ambiente de testes
          example: false
        v2:
          type: boolean
          description: Indica se o webhook usa o formato de payload v2
          example: true
        createdAt:
          type: string
          format: date-time
          description: Data de criação do webhook
          example: '2025-01-01T00:00:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização do webhook
          example: '2025-01-01T00:00:00.000Z'
    Success:
      type: boolean
      description: Se a requisição obteve sucesso ou não.
      example: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Todas as requisições devem incluir sua chave de API no header
        Authorization usando o formato `Bearer <abacatepay-api-key>`. Sem esse
        header a requisição será rejeitada.


        Saiba mais sobre como criar e usar chaves de API na [documentação de
        autenticação](/pages/authentication).

````