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

# Cadastrar webhook

> Cadastra URL de eventos vinculada à API key.

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST 'https://api.goatpay.com.br/v1/webhooks/create' \
    -H 'X-API-Key: gp_live_SUA_CHAVE' \
    -H 'Content-Type: application/json' \
    -d '{ "url": "https://api.suaempresa.com/webhooks/goatpay", "description": "ERP produção", "events": ["payment.paid", "transfer.completed"] }'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Webhook criado com sucesso",
    "data": {
      "item": {
        "id": "clx_webhook",
        "url": "https://api.suaempresa.com/webhooks/goatpay",
        "description": "ERP produção",
        "events": ["payment.paid", "transfer.completed"],
        "status": "ACTIVE",
        "createdAt": "2026-07-01T12:00:00.000Z"
      },
      "secret": "whsec_..."
    },
    "requestId": "req_abc"
  }
  ```
</ResponseExample>

### Corpo da requisição

<ParamField body="url" type="string" required>
  URL HTTPS pública.
</ParamField>

<ParamField body="description" type="string" required>
  Nome do endpoint.
</ParamField>

<ParamField body="events" type="array" required>
  Lista de eventos. Veja o guia Webhooks.
</ParamField>

<Note>
  A resposta inclui secret whsec\_... exibido uma única vez.
</Note>


## OpenAPI

````yaml POST /webhooks/create
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /webhooks/create:
    post:
      tags:
        - webhooks
      summary: Cadastrar endpoint de webhook
      description: >-
        Retorna `secret` (`whsec_...`) uma única vez. Endpoint fica vinculado à
        API key usada.
      operationId: createWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhook'
      responses:
        '200':
          $ref: '#/components/responses/WebhookCreateSuccess'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    CreateWebhook:
      type: object
      required:
        - url
        - description
        - events
      properties:
        url:
          type: string
          format: uri
          description: HTTPS obrigatório.
        description:
          type: string
          maxLength: 120
        events:
          type: array
          minItems: 1
          maxItems: 80
          items:
            type: string
            enum:
              - payment.created
              - payment.paid
              - payment.failed
              - payment.refunded
              - payment.pix.expired
              - payment.crypto.created
              - payment.crypto.paid
              - payment.crypto.failed
              - payment.crypto.expired
              - transfer.created
              - transfer.crypto.completed
              - transfer.crypto.failed
              - transfer.completed
              - transfer.failed
              - med.created
              - med.updated
              - med.evidence_sent
              - webhook.test
    PublicWebhookCreateData:
      type: object
      properties:
        item:
          $ref: '#/components/schemas/PublicWebhookEndpoint'
        secret:
          type: string
          description: Segredo `whsec_...` exibido apenas na criação ou rotação.
          example: whsec_abc123def456
    ErrorEnvelope:
      type: object
      required:
        - success
        - message
        - error
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Subconta inativa
        error:
          type: object
          properties:
            code:
              type: string
              example: Bad Request
            statusCode:
              type: integer
              example: 400
        requestId:
          type: string
          example: req_abc123
    PublicWebhookEndpoint:
      type: object
      properties:
        id:
          type: string
        url:
          type: string
          format: uri
        description:
          type: string
        events:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
            - ACTIVE
            - DISABLED
            - PENDING_SECRET
        createdAt:
          type: string
          format: date-time
  responses:
    WebhookCreateSuccess:
      description: Webhook cadastrado (secret exibido uma vez).
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
              message:
                type: string
              data:
                $ref: '#/components/schemas/PublicWebhookCreateData'
              requestId:
                type: string
          examples:
            created:
              summary: Endpoint criado
              value:
                success: true
                message: Webhook criado com sucesso
                data:
                  item:
                    id: clx_webhook
                    url: https://api.exemplo.com/webhooks/goatpay
                    description: Produção
                    events:
                      - payment.paid
                      - transfer.completed
                    status: ACTIVE
                    createdAt: '2026-06-01T10:00:00.000Z'
                  secret: whsec_abc123def456ghi789
                requestId: req_wh001
    Forbidden:
      description: Chave sem permissão para este endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````