> ## Documentation Index > Fetch the complete documentation index at: https://docs.usecorvex.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Criar webhook > O `secret` é opcional e nunca volta nas respostas. Use `hasSecret` para saber se está configurado. ## OpenAPI ````yaml /openapi.json post /api/v1/webhooks openapi: 3.0.3 info: title: Corvex API version: 1.0.0 description: >- API pública da Corvex para gerenciar catálogo, pedidos, checkout marketing, webhooks, clientes e leads. Autenticação exclusiva por API Key (`Authorization: Bearer cvx_live_...`). servers: - url: https://apiv3.usecorvex.com.br description: Produção - url: http://localhost:3333 description: Desenvolvimento local security: - bearerAuth: [] tags: - name: Checkout externo description: >- Criar link de pagamento a partir de um carrinho no seu site. Autenticação com `x-api-key` do painel (não é a API v1 `cvx_live_...`). - name: Produtos description: >- Catálogo da loja. Variantes aparecem só na consulta por id, em modo leitura. - name: Coleções description: Categorias da loja. Use para agrupar produtos na vitrine. - name: Kits description: Pacotes de produtos vendidos juntos. - name: Pedidos description: Pedidos da loja. Criar pedido continua no checkout, não nesta API. - name: Rastreio description: Envios e códigos de rastreio. - name: Carrinhos abandonados description: Checkouts iniciados e não concluídos. - name: Clientes description: Compradores agrupados por documento. - name: Leads description: Contatos capturados na loja virtual. - name: Order bumps description: Ofertas extras no checkout. - name: Brindes description: Brindes liberados por regras de carrinho. - name: Upsell one-click description: Oferta pós-compra com um clique. - name: Cupons description: 'Cupons de desconto. Não há exclusão: altere o status.' - name: Faixas de desconto description: Desconto progressivo por valor ou quantidade. - name: Desconto por pagamento description: Percentual por PIX, cartão ou boleto. Um desconto por método. - name: Webhooks description: >- URLs chamadas quando eventos da loja acontecem. O secret nunca é devolvido. - name: Automações description: >- Fluxos, templates de mensagem e metatags. Automações novas nascem desativadas (`active: false`). paths: /api/v1/webhooks: post: tags: - Webhooks summary: Criar webhook description: >- O `secret` é opcional e nunca volta nas respostas. Use `hasSecret` para saber se está configurado. operationId: createWebhook parameters: - $ref: '#/components/parameters/StoreId' requestBody: required: true content: application/json: example: name: ERP pedidos description: null url: https://example.com/hooks/corvex events: - ORDER_CREATED - ORDER_PAID secret: optional-signing-secret active: true retryAttempts: 3 timeout: 30 headers: null schema: type: object required: - name - url - events properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 500 url: type: string format: uri maxLength: 500 description: URL HTTPS que recebe o POST. events: type: array minItems: 1 maxItems: 20 items: type: string enum: - ORDER_CREATED - ORDER_PAID - ORDER_REFUNDED - ORDER_CANCELLED - ORDER_COMPLETED - SUBSCRIPTION_CREATED - SUBSCRIPTION_CANCELLED - SUBSCRIPTION_RENEWED - CUSTOMER_CREATED - CUSTOMER_UPDATED - PRODUCT_CREATED - PRODUCT_UPDATED - PRODUCT_DELETED - CHECKOUT_CREATED - CHECKOUT_UPDATED - CART_ABANDONED - PAYMENT_PROCESSED - PAYMENT_FAILED - MEMBER_AREA_ACCESS_GRANTED - MEMBER_AREA_ACCESS_REVOKED description: Eventos que disparam o webhook. secret: type: string maxLength: 100 description: Opcional. Nunca volta nas respostas; use hasSecret. active: type: boolean retryAttempts: type: integer minimum: 0 maximum: 10 description: Padrão 3. timeout: type: integer minimum: 5 maximum: 300 description: Timeout em segundos. Padrão 30. headers: type: object additionalProperties: type: string description: Headers extras no POST. null para limpar. nullable: true responses: '201': description: Criado. content: application/json: example: success: true data: webhook: id: cccccccc-cccc-4ccc-8ccc-cccccccccccc storeId: 11111111-1111-4111-8111-111111111111 name: ERP pedidos description: null url: https://example.com/hooks/corvex events: - ORDER_CREATED - ORDER_PAID active: true retryAttempts: 3 timeout: 30 hasSecret: true headers: null createdAt: '2026-09-24T14:00:00.000Z' updatedAt: '2026-09-24T14:00:00.000Z' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/RateLimited' components: parameters: StoreId: name: X-Store-Id in: header required: true schema: type: string format: uuid description: UUID da loja. A chave precisa ter esta loja autorizada. example: 11111111-1111-4111-8111-111111111111 responses: ValidationError: description: Header `X-Store-Id`, query ou body inválidos. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false error: message: X-Store-Id deve ser um UUID válido code: VALIDATION_ERROR meta: timestamp: '2026-09-24T14:00:00.000Z' status: 400 Unauthorized: description: API Key ausente, inválida, expirada ou revogada. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false error: message: >- Esta rota exige uma API Key. Use Authorization: Bearer cvx_live_... code: AUTH_API_KEY_REQUIRED meta: timestamp: '2026-09-24T14:00:00.000Z' status: 401 Forbidden: description: >- Falta o escopo desta operação (`AUTH_SCOPE_DENIED`) ou a loja não está autorizada na chave (`AUTH_STORE_ACCESS_DENIED`). content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false error: message: Sua API Key não tem o escopo necessário para esta operação. code: AUTH_SCOPE_DENIED meta: timestamp: '2026-09-24T14:00:00.000Z' status: 403 RateLimited: description: Muitas requisições. Respeite Retry-After. headers: Retry-After: schema: type: integer description: Segundos até poder tentar de novo. content: application/json: schema: type: object properties: success: type: boolean example: false message: type: string error: type: string example: RATE_LIMITED retryAfter: type: integer example: success: false message: Muitas requisições. Tente novamente em instantes. error: RATE_LIMITED retryAfter: 12 schemas: ErrorBody: type: object properties: success: type: boolean example: false error: type: object properties: message: type: string code: type: string details: {} meta: type: object properties: timestamp: type: string format: date-time status: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- API Key no formato `cvx_live_...`, criada no painel Corvex. Não use JWT de sessão nem `x-api-key`. ````